|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DatastoreClass
Representation of a Java class in a datastore. In the case of RDBMS this will be a table (primary or secondary). In the case of a file-based structure this may be a directory. In the case of an XML-based structure this may be an element.
Method Summary | |
---|---|
void |
delete(StateManager sm)
Method to delete an object for this class. |
void |
deleteDependent(StateManager sm,
AbstractPropertyMetaData[] fieldMetaData)
Delete dependent objects of a persistent object. |
void |
fetch(StateManager sm,
AbstractPropertyMetaData[] fieldMetaData)
Method to fetch an object for this class. |
DatastoreClass |
getBaseDatastoreClassWithField(AbstractPropertyMetaData fmd)
Method to return the base DatastoreClass that persists the specified field. |
JavaTypeMapping |
getDataStoreObjectIdMapping()
Accessor for a mapping for the datastore ID (OID) for this object. |
JavaTypeMapping |
getExternalFkDiscriminatorMapping(AbstractPropertyMetaData fmd)
Accessor for the external FK discriminator mapping for an owner field. |
JavaTypeMapping |
getExternalFkMapping(AbstractPropertyMetaData fmd)
Accessor for the external FK mapping for an owner field. |
JavaTypeMapping |
getExternalOrderMapping(AbstractPropertyMetaData fmd)
Accessor for the external order mapping specified by the field. |
JavaTypeMapping |
getFieldMapping(AbstractPropertyMetaData fmd)
Accessor for the mapping for the specified field. |
JavaTypeMapping |
getFieldMapping(java.lang.String fieldName)
Accessor for the mapping for the specified field name. |
AbstractPropertyMetaData |
getFieldMetaData(java.lang.String fieldName)
Acessor for the FieldMetaData of a field. |
IdentityType |
getIdentityType()
Accessor for the identity-type used by this table. |
java.lang.String |
getType()
Accessor for the primary class represented. |
void |
insert(StateManager sm)
Method to insert an object for this class. |
boolean |
isBaseDatastoreClass()
Accessor for whether this datastore class is the base datastore class for this inheritance hierarchy. |
boolean |
isObjectIDDatastoreAttributed()
Accessor for whether the object id will be attributed by the datastore directly, or whether values have to be supplied. |
void |
locate(StateManager sm)
Locates this object in the datastore. |
java.lang.Object |
newOID(PersistenceManager pm,
javax.jdo.spi.PersistenceCapable pcClass)
Create a new OID. |
void |
provideDatastoreIdMappings(MappingConsumer consumer)
Accessor for a mapping for the datastore ID (OID) for this table. |
void |
provideDiscriminatorMappings(MappingConsumer consumer)
Provide the mappings to discriminator mappings |
void |
provideExternalFkMappings(MappingConsumer consumer)
Provide the mappings to external FK mappings |
void |
provideExternalOrderMappings(MappingConsumer consumer)
Provide the mappings to external order mappings |
void |
provideMappingsForFields(MappingConsumer consumer,
AbstractPropertyMetaData[] fieldMetaData,
boolean includeSecondaryTables)
Provide the mappings to the consumer for all absolute field Numbers in this table that are container in the fieldNumbers parameter. |
void |
provideNonPrimaryKeyMappings(MappingConsumer consumer)
Provide the mappings to the consumer for all non primary-key fields mapped to this table. |
void |
providePrimaryKeyMappings(MappingConsumer consumer)
Provide the mappings to the consumer for all primary-key fields mapped to this table (for application identity). |
void |
provideVersionMappings(MappingConsumer consumer)
Provide the mappings to version mappings |
java.lang.String |
toString()
Accessor for the name of the datastore class (table). |
void |
update(StateManager sm,
AbstractPropertyMetaData[] fieldMetaData)
Method to update an object for this class. |
Methods inherited from interface org.jpox.store.DatastoreContainerObject |
---|
addDatastoreField, getDiscriminatorMapping, getDiscriminatorMetaData, getIDMapping, getVersionMapping, getVersionMetaData, hasDatastoreField |
Methods inherited from interface org.jpox.store.DatastoreObject |
---|
getIdentifier, getStoreManager |
Method Detail |
---|
java.lang.String getType()
IdentityType getIdentityType()
boolean isObjectIDDatastoreAttributed()
boolean isBaseDatastoreClass()
DatastoreClass getBaseDatastoreClassWithField(AbstractPropertyMetaData fmd)
fmd
- MetaData for the field required
void insert(StateManager sm)
sm
- StateManager for the object to insert.void fetch(StateManager sm, AbstractPropertyMetaData[] fieldMetaData)
sm
- StateManager for the object to fetch.fieldMetaData
- MetaData for the fields to be fetchedvoid update(StateManager sm, AbstractPropertyMetaData[] fieldMetaData)
sm
- StateManager for the object to update.fieldMetaData
- MetaData for the fields to be updatedvoid delete(StateManager sm)
sm
- StateManager for the object to delete.void locate(StateManager sm)
sm
- The StateManager for the object to be found
javax.jdo.JDOObjectNotFoundException
- If the instance does not exist in
the datastorevoid deleteDependent(StateManager sm, AbstractPropertyMetaData[] fieldMetaData)
sm
- StateManager for the object being deleted.fieldMetaData
- MetaData for the fields to delete.AbstractPropertyMetaData getFieldMetaData(java.lang.String fieldName)
fieldName
- the field name
java.lang.String toString()
toString
in class java.lang.Object
JavaTypeMapping getDataStoreObjectIdMapping()
JavaTypeMapping getFieldMapping(java.lang.String fieldName)
fieldName
- Name of field
JavaTypeMapping getFieldMapping(AbstractPropertyMetaData fmd)
getFieldMapping
in interface DatastoreContainerObject
fmd
- AbstractPropertyMetaData of the field
void provideDatastoreIdMappings(MappingConsumer consumer)
consumer
- Consumer for the mappingsvoid providePrimaryKeyMappings(MappingConsumer consumer)
consumer
- Consumer for the mappingsvoid provideNonPrimaryKeyMappings(MappingConsumer consumer)
consumer
- Consumer for the mappingsvoid provideMappingsForFields(MappingConsumer consumer, AbstractPropertyMetaData[] fieldMetaData, boolean includeSecondaryTables)
consumer
- Consumer for the mappingsfieldMetaData
- MetaData of the fields to provide mappings forincludeSecondaryTables
- Whether to supply fields in secondary tablesvoid provideVersionMappings(MappingConsumer consumer)
consumer
- Consumer for the version mappingsvoid provideDiscriminatorMappings(MappingConsumer consumer)
consumer
- Consumer for the mappingsvoid provideExternalFkMappings(MappingConsumer consumer)
consumer
- Consumer for the mappingsvoid provideExternalOrderMappings(MappingConsumer consumer)
consumer
- Consumer for the mappingsjava.lang.Object newOID(PersistenceManager pm, javax.jdo.spi.PersistenceCapable pcClass)
pm
- The PersistenceManagerpcClass
- The Persistence-Capable class
JavaTypeMapping getExternalOrderMapping(AbstractPropertyMetaData fmd)
fmd
- The metadata for the List field.
JavaTypeMapping getExternalFkDiscriminatorMapping(AbstractPropertyMetaData fmd)
fmd
- The metadata for the field.
JavaTypeMapping getExternalFkMapping(AbstractPropertyMetaData fmd)
fmd
- The metadata for the field.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |