A B C D E F G O P R S W

A

addHost(String, int) - Method in class jpa.p1.pub.Publisher

This method adds a PlatformOne server to the list of alternatives for making a connection to.

B

beginUpdate(PubUpdateEvent) - Method in class jpa.p1.pub.PubRecord

This method begins a series of field updates, returning a reference to an PubUpdate object.

C

cancel(PubDatasetEvent) - Method in class jpa.p1.pub.PubDataset

This method cancels a watch on the dataset.

cancel(PubDatasetListEvent) - Method in class jpa.p1.pub.PubDatasetList

This method cancels a watch on the dataset list.

canPublishPages() - Method in class jpa.p1.pub.PubDataset

This method checks to see if this dataset will accept publication of pages; page publishing is not supported in this release of the JPA PlatformOne Publishing package.

canPublishRecords() - Method in class jpa.p1.pub.PubDataset

This method checks to see if this dataset will accept publication of records.

clearHosts() - Method in class jpa.p1.pub.Publisher

This method clears the list of alternative PlatformOne server hosts.

close() - Method in class jpa.p1.pub.PubRecord

This method closes the record.

connect() - Method in class jpa.p1.pub.Publisher

This method attempts to establish a connection to the first available server host.

connectToHost(String, int) - Method in class jpa.p1.pub.Publisher

This method attempts to establish a connection to the specified PlatformOne server host.

createRecord(String) - Method in class jpa.p1.pub.PubDataset

This method creates a new, empty record object.

D

deleteRecord(PubRecord) - Method in class jpa.p1.pub.PubDataset

This method deletes a record object.

disconnect() - Method in class jpa.p1.pub.Publisher

This method disconnects from the current PlatformOne server host, or abandons connection attempts if there is currently no connection.

E

end() - Method in class jpa.p1.pub.PubUpdate

This method ends the series of updates and sends it to the publishing host.

F

FIELDTYPE_ATTR - Static variable in class jpa.p1.pub.PubConstants

Attribute - not used by client applications

FIELDTYPE_NONE - Static variable in class jpa.p1.pub.PubConstants

Field type unknown

FIELDTYPE_NUMERIC - Static variable in class jpa.p1.pub.PubConstants

Numeric

FIELDTYPE_PRICE - Static variable in class jpa.p1.pub.PubConstants

Price - as numeric, but may have coloration applied by client application

FIELDTYPE_TEXT - Static variable in class jpa.p1.pub.PubConstants

Text

G

getDataset() - Method in class jpa.p1.pub.PubRecord

This method returns a reference to the parent dataset.

getDataset() - Method in class jpa.p1.pub.PubSchema

This method returns a reference to the object representing the dataset to which this schema belongs.

getDataset(String) - Method in class jpa.p1.pub.Publisher

This method gets a reference to an object representing a dataset.

getDatasetList() - Method in class jpa.p1.pub.Publisher

This method gets a reference to the object representing the dataset list.

getField(int) - Method in class jpa.p1.pub.PubSchema

This method returns a reference to the object representing an individual field in the schema.

getName() - Method in class jpa.p1.pub.PubDataset

This method returns the dataset name.

getName() - Method in class jpa.p1.pub.PubField

This method returns the field name.

getName() - Method in class jpa.p1.pub.PubRecord

This method returns the record name.

getName() - Method in class jpa.p1.pub.PubSchema

This method returns the name of the schema.

getNumField() - Method in class jpa.p1.pub.PubSchema

This method returns the number of fields in the schema.

getNumSchema() - Method in class jpa.p1.pub.PubDataset

This method returns the number of available schemata.

getSchema(int) - Method in class jpa.p1.pub.PubDataset

This method returns a reference to an individual schema.

getType() - Method in class jpa.p1.pub.PubField

This method returns the field type.

getUser() - Method in class jpa.p1.pub.Publisher

This method gets the current user name.

O

onAddDataset(String) - Method in interface jpa.p1.pub.PubDatasetListEvent

This method is invoked whenever a dataset is added to the list.

onConnected() - Method in interface jpa.p1.pub.PublisherEvent

This method is invoked when a connection has been successfully established to a PlatformOne server host.

onConnectFailed() - Method in interface jpa.p1.pub.PublisherEvent

This method is invoked when a connection attempt to a PlatformOne server host has failed.

onDeleteDataset(String) - Method in interface jpa.p1.pub.PubDatasetListEvent

This method is invoked whenever a dataset is deleted from the list.

onDisconnected() - Method in interface jpa.p1.pub.PublisherEvent

This method is invoked when an established connection to a PlatformOne server host has failed.

onImage(Vector) - Method in interface jpa.p1.pub.PubDatasetListEvent

This method is invoked when an initial image of the dataset list is received.

onReady(boolean) - Method in interface jpa.p1.pub.PubDatasetEvent

This method is invoked whenever a dataset is ready to receive published data, or if it ceases to be able to accept data.

onStatus(String) - Method in interface jpa.p1.pub.PublisherEvent

This method is invoked when a status message has been received.

onUpdated() - Method in interface jpa.p1.pub.PubRecordEvent

onUpdated() - Method in interface jpa.p1.pub.PubUpdateEvent

This method is invoked when an update has been received by the publishing host.

open(String, boolean) - Method in class jpa.p1.pub.PubRecord

This method opens the record for publication.

P

PubConstants - class jpa.p1.pub.PubConstants.

This class contains various constants used throughout the JPA PlatformOne Publishing package.

PubConstants() - Constructor for class jpa.p1.pub.PubConstants

PubDataset - class jpa.p1.pub.PubDataset.

This class represents a single PlatformOne dataset.

PubDatasetEvent - interface jpa.p1.pub.PubDatasetEvent.

This interface is the event counterpart to the PubDataset interface.

PubDatasetList - class jpa.p1.pub.PubDatasetList.

This class represents a single PlatformOne dataset list.

PubDatasetListEvent - interface jpa.p1.pub.PubDatasetListEvent.

This interface is the event counterpart to the PubDatasetList interface.

PubField - class jpa.p1.pub.PubField.

This class represents a single PlatformOne field.

Publisher - class jpa.p1.pub.Publisher.

This is the main class in the JPA PlatformOne Publishing package, which is used for subscribing to PlatformOne data.

Publisher(PublisherEvent) - Constructor for class jpa.p1.pub.Publisher

This is the sole constructor for Publisher.

PublisherEvent - interface jpa.p1.pub.PublisherEvent.

This interface is the event counterpart to the Publisher interface.

PubRecord - class jpa.p1.pub.PubRecord.

This class represents a single PlatformOne record.

PubRecordEvent - interface jpa.p1.pub.PubRecordEvent.

PubSchema - class jpa.p1.pub.PubSchema.

This class represents a single PlatformOne schema.

PubUpdate - class jpa.p1.pub.PubUpdate.

This class represents a series of field updates to a PlatformOne published record.

PubUpdateEvent - interface jpa.p1.pub.PubUpdateEvent.

This interface is the event counterpart to the PubUpdate interface.

R

RECORDSTATE_ABORT - Static variable in class jpa.p1.pub.PubConstants

Record has been aborted

RECORDSTATE_INIT - Static variable in class jpa.p1.pub.PubConstants

Record has been initialised

RECORDSTATE_NOTPERMITTED - Static variable in class jpa.p1.pub.PubConstants

Record is not permitted to be seen by this client

RECORDSTATE_OUTOFDATE - Static variable in class jpa.p1.pub.PubConstants

Record is out of date

RECORDSTATE_SCHEMA - Static variable in class jpa.p1.pub.PubConstants

Schema has been retrieved

RECORDSTATE_VALID - Static variable in class jpa.p1.pub.PubConstants

Record is valid

RECORDSTATE_WAITING - Static variable in class jpa.p1.pub.PubConstants

Record is waiting for image

S

setValue(String, String, String) - Method in class jpa.p1.pub.PubUpdate

This method sets the value of a single field.

W

watch(PubDatasetEvent) - Method in class jpa.p1.pub.PubDataset

This method watches the dataset to see when it is ready to receive published data.

watch(PubDatasetListEvent) - Method in class jpa.p1.pub.PubDatasetList

This method watches the dataset list.

A B C D E F G O P R S W