org.jpox.store
Interface DatastoreContainerObject

All Superinterfaces:
DatastoreObject
All Known Subinterfaces:
DatastoreClass, SCOTable, Table
All Known Implementing Classes:
AbstractTable, ClassTable, ClassView, ElementContainerTable, JoinTable, MapTable, SecondaryTable

public interface DatastoreContainerObject
extends DatastoreObject

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

Version:
$Revision: 1.11 $

Method Summary
 DatastoreField addDatastoreField(java.lang.String storedJavaType, DatastoreIdentifier name, JavaTypeMapping mapping, ExtendableMetaData colmd)
          Method to add a new column to the internal representation.
 JavaTypeMapping getDiscriminatorMapping()
          Accessor for the discriminator mapping specified.
 DiscriminatorMetaData getDiscriminatorMetaData()
          Accessor for Discriminator MetaData.
 JavaTypeMapping getFieldMapping(AbstractPropertyMetaData fmd)
          Accessor for the mapping for the specified FieldMetaData.
 JavaTypeMapping getIDMapping()
          Accessor for the ID mapping of this container object.
 JavaTypeMapping getVersionMapping()
          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.DatastoreObject
getIdentifier, getStoreManager
 

Method Detail

addDatastoreField

public DatastoreField addDatastoreField(java.lang.String storedJavaType,
                                        DatastoreIdentifier name,
                                        JavaTypeMapping mapping,
                                        ExtendableMetaData 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 ExtendableMetaData (ColumnMetaData for RDBMS)
Returns:
The new Column

hasDatastoreField

public 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

public JavaTypeMapping getIDMapping()
Accessor for the ID mapping of this container object.

Returns:
The ID Mapping (if present)

getFieldMapping

public JavaTypeMapping getFieldMapping(AbstractPropertyMetaData 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

public DiscriminatorMetaData getDiscriminatorMetaData()
Accessor for Discriminator MetaData.

Returns:
Returns the Discriminator MetaData.

getDiscriminatorMapping

public JavaTypeMapping getDiscriminatorMapping()
Accessor for the discriminator mapping specified.

Returns:
The mapping for the discriminator datastore field

getVersionMetaData

public VersionMetaData getVersionMetaData()
Accessor for the Version MetaData.

Returns:
Returns the Version MetaData.

getVersionMapping

public JavaTypeMapping getVersionMapping()
Accessor for the version mapping specified .

Returns:
The version mapping.


Copyright © -2007 . All Rights Reserved.