org.jpox.store.mapped
Interface DatastoreContainerObject

All Superinterfaces:

DatastoreObject

All Known Subinterfaces:

DatastoreArray, DatastoreClass, DatastoreCollection, DatastoreContainer, DatastoreElementContainer, DatastoreMap, SecondaryDatastoreClass

public interface DatastoreContainerObject
extends DatastoreObject

This represents a container of fields. Such as table (container of columns), file, etc.

Version:

$Revision: 1.15 $

Method Summary

DatastoreField	addDatastoreField(java.lang.String storedJavaType, DatastoreIdentifier name, JavaTypeMapping mapping, MetaData colmd) Method to add a new column to the internal representation.
DatastoreField[]	getDatastoreFieldsMetaData() Accessor for the DatastoreFields infered from the java and metadata files.
JavaTypeMapping	getDiscriminatorMapping(boolean allowSuperclasses) Accessor for the discriminator mapping specified.
DiscriminatorMetaData	getDiscriminatorMetaData() Accessor for Discriminator MetaData.
JavaTypeMapping	getFieldMapping(AbstractMemberMetaData fmd) Accessor for the mapping for the specified FieldMetaData.
JavaTypeMapping	getIDMapping() Accessor for the ID mapping of this container object.
JavaTypeMapping	getVersionMapping(boolean allowSuperclasses) Accessor for the version mapping specified .
VersionMetaData	getVersionMetaData() Accessor for the Version MetaData.
boolean	hasDatastoreField(DatastoreIdentifier identifier) Checks if there is a DatastoreField for the identifier

Methods inherited from interface org.jpox.store.mapped.DatastoreObject

getIdentifier, getStoreManager

Method Detail

addDatastoreField

DatastoreField addDatastoreField(java.lang.String storedJavaType,
                                 DatastoreIdentifier name,
                                 JavaTypeMapping mapping,
                                 MetaData colmd)

Method to add a new column to the internal representation.

Parameters:

storedJavaType - The type of the Java field to store

name - The name of the column

mapping - The type mapping for this column

colmd - The MetaData (ColumnMetaData for RDBMS)

Returns:

The new Column

hasDatastoreField

boolean hasDatastoreField(DatastoreIdentifier identifier)

Checks if there is a DatastoreField for the identifier

Parameters:

identifier - the identifier of the DatastoreField

Returns:

true if the DatastoreField exists for the identifier

getIDMapping

JavaTypeMapping getIDMapping()

Accessor for the ID mapping of this container object.

Returns:

The ID Mapping (if present)

getFieldMapping

JavaTypeMapping getFieldMapping(AbstractMemberMetaData fmd)

Accessor for the mapping for the specified FieldMetaData. A datastore container object may store many fields.

Parameters:

fmd - the FieldMetaData

Returns:

The Mapping for the field, or null if the FieldMetaData cannot be found

getDiscriminatorMetaData

DiscriminatorMetaData getDiscriminatorMetaData()

Accessor for Discriminator MetaData.

Returns:

Returns the Discriminator MetaData.

getDiscriminatorMapping

JavaTypeMapping getDiscriminatorMapping(boolean allowSuperclasses)

Accessor for the discriminator mapping specified.

Parameters:

allowSuperclasses - Whether we should return just the mapping from this table or whether we should return it when this table has none and the supertable has

Returns:

The discriminator mapping

getVersionMetaData

VersionMetaData getVersionMetaData()

Accessor for the Version MetaData.

Returns:

Returns the Version MetaData.

getVersionMapping

JavaTypeMapping getVersionMapping(boolean allowSuperclasses)

Accessor for the version mapping specified .

Parameters:

allowSuperclasses - Whether we should return just the mapping from this table or whether we should return it when this table has none and the supertable has

Returns:

The version mapping.

getDatastoreFieldsMetaData

DatastoreField[] getDatastoreFieldsMetaData()

Accessor for the DatastoreFields infered from the java and metadata files.

Returns:

the DatastoreField[]