org.datanucleus.metadata

Class InterfaceMetaData

java.lang.Object

org.datanucleus.metadata.MetaData

org.datanucleus.metadata.AbstractClassMetaData

org.datanucleus.metadata.InterfaceMetaData

All Implemented Interfaces:

Serializable

public class InterfaceMetaData
extends AbstractClassMetaData

Representation of the MetaData of a "persistent-interface".

See Also:

Serialized Form

Field Summary

Fields inherited from class org.datanucleus.metadata.AbstractClassMetaData

accessViaField, allMemberPositions, cacheable, catalog, detachable, dfgMemberFlags, dfgMemberPositions, embeddedOnly, entityName, excludeDefaultListeners, excludeSuperClassListeners, fetchGroupMetaDataByName, fetchGroupMetaWithPostLoad, fetchGroups, foreignKeyMetaData, foreignKeys, fullName, GENERATED_PK_SUFFIX, hasRelations, identityMetaData, identitySpecified, identityType, implementationOfPersistentDefinition, indexes, indexMetaData, inheritanceMetaData, instantiable, joinMetaData, joins, listeners, managedMembers, mappedSuperclass, memberCount, memberPositionsByName, members, metaDataComplete, name, nonPkMemberFlags, nonPkMemberPositions, noOfInheritedManagedMembers, objectidClass, overriddenMembers, pcSuperclassMetaData, persistableSuperclass, persistenceModifier, persistentInterfaceImplNeedingTableFromSubclass, persistentInterfaceImplNeedingTableFromSuperclass, pkIsDatastoreAttributed, pkMemberPositions, primaryKeyMetaData, queries, queryResultMetaData, relationPositions, requiresExtent, schema, scoMutableMemberFlags, scoMutableMemberPositions, scoNonContainerMemberPositions, secondClassContainerMemberPositions, serializeRead, storedProcQueries, table, uniqueConstraints, uniqueMetaData, unmappedColumns, usesSingleFieldIdentityClass, versionMetaData

Fields inherited from class org.datanucleus.metadata.MetaData

EXTENSION_CLASS_MULTITENANCY_COLUMN_LENGTH, EXTENSION_CLASS_MULTITENANCY_COLUMN_NAME, EXTENSION_CLASS_MULTITENANCY_DISABLE, EXTENSION_CLASS_MULTITENANCY_JDBC_TYPE, EXTENSION_CLASS_READ_ONLY, EXTENSION_CLASS_VERSION_FIELD_NAME, EXTENSION_MEMBER_CACHEABLE, EXTENSION_MEMBER_CALENDAR_ONE_COLUMN, EXTENSION_MEMBER_CASCADE_PERSIST, EXTENSION_MEMBER_CASCADE_REFRESH, EXTENSION_MEMBER_CASCADE_UPDATE, EXTENSION_MEMBER_COMPARATOR_NAME, EXTENSION_MEMBER_CONTAINER_ALLOW_NULLS, EXTENSION_MEMBER_ENUM_GETTER_BY_VALUE, EXTENSION_MEMBER_ENUM_VALUE_GETTER, EXTENSION_MEMBER_FETCH_FK_ONLY, EXTENSION_MEMBER_IMPLEMENTATION_CLASSES, EXTENSION_MEMBER_INSERTABLE, EXTENSION_MEMBER_LIST_ORDERING, EXTENSION_MEMBER_STRATEGY_WHEN_NOTNULL, EXTENSION_MEMBER_TYPE_CONVERTER_DISABLED, EXTENSION_MEMBER_TYPE_CONVERTER_NAME, EXTENSION_MEMBER_UPDATEABLE, extensions, METADATA_CREATED_STATE, METADATA_INITIALISED_STATE, METADATA_POPULATED_STATE, METADATA_USED_STATE, metaDataState, parent, VENDOR_NAME

Constructor Summary

Constructors

Constructor and Description
InterfaceMetaData(PackageMetaData parent, String name) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addMetaDataForMembersNotInMetaData(Class cls) Add MetaData for properties of the interface not declared in MetaData.
void	initialise(ClassLoaderResolver clr, MetaDataManager mmgr) Method to initialise the object, creating internal convenience arrays.
protected AbstractMemberMetaData	newDefaultedProperty(String name) Utility to add a defaulted PropertyMetaData to the class.
void	populate(ClassLoaderResolver clr, ClassLoader primary, MetaDataManager mmgr) Method to provide the details of the class being represented by this MetaData.
protected void	populatePropertyMetaData(ClassLoaderResolver clr, Class cls, boolean pkFields, ClassLoader primary, MetaDataManager mmgr) Populate PropertyMetaData.
String	toString(String prefix, String indent) Returns a string representation of the object.

Methods inherited from class org.datanucleus.metadata.AbstractClassMetaData

addFetchGroup, addForeignKey, addIndex, addJoin, addListener, addMember, addQuery, addQueryResultMetaData, addStoredProcQuery, addUniqueConstraint, addUnmappedColumn, applyDefaultDiscriminatorValueWhenNotSpecified, checkInitialised, checkNotYetPopulated, checkPopulated, copyMembersFromInterface, determineIdentity, determineInheritanceMetaData, determineObjectIdClass, determineSuperClassName, excludeDefaultListeners, excludeSuperClassListeners, getAbsoluteMemberPositionForRelativePosition, getAbsolutePositionOfMember, getAbsolutePositionOfMember, getAccessViaField, getAllMemberPositions, getBaseAbstractClassMetaData, getBaseIdentityMetaData, getBaseInheritanceStrategy, getBasicMemberPositions, getBidirectionalRelationMemberPositions, getCatalog, getDFGMemberFlags, getDFGMemberPositions, getDiscriminatorColumnMetaData, getDiscriminatorColumnName, getDiscriminatorMetaData, getDiscriminatorMetaDataForTable, getDiscriminatorMetaDataRoot, getDiscriminatorStrategy, getDiscriminatorStrategyForTable, getDiscriminatorValue, getEntityName, getFetchGroupMetaData, getFetchGroupMetaData, getFetchGroupMetaData, getForeignKeyMetaData, getFullClassName, getIdentityMetaData, getIdentityType, getIndexMetaData, getInheritanceMetaData, getJoinMetaData, getListenerForClass, getListeners, getManagedMembers, getMemberBeingOverridden, getMemberCount, getMetaDataForManagedMemberAtAbsolutePosition, getMetaDataForManagedMemberAtAbsolutePositionInternal, getMetaDataForManagedMemberAtRelativePosition, getMetaDataForMember, getMetaDataForMemberAtRelativePosition, getMultivaluedMemberPositions, getName, getNonPKMemberFlags, getNonPKMemberPositions, getNonRelationMemberPositions, getNoOfInheritedManagedMembers, getNoOfManagedMembers, getNoOfMembers, getNoOfOverriddenMembers, getNoOfPrimaryKeyMembers, getNoOfQueries, getNoOfStoredProcQueries, getObjectidClass, getOverriddenMember, getOverriddenMembers, getPackageMetaData, getPackageName, getPersistableSuperclass, getPersistenceModifier, getPKMemberPositions, getPrimaryKeyMemberNames, getPrimaryKeyMetaData, getQueries, getQueryResultMetaData, getRelationMemberPositions, getRelativePositionOfMember, getRootInstantiableClass, getSchema, getSCOContainerMemberPositions, getSCOMutableMemberFlags, getSCOMutableMemberPositions, getSCONonContainerMemberPositions, getStoredProcQueries, getSuperAbstractClassMetaData, getTable, getUniqueMetaData, getUnmappedColumns, getVersionMetaData, getVersionMetaDataForClass, getVersionMetaDataForTable, hasDiscriminatorStrategy, hasFetchGroupWithPostLoad, hasMember, hasRelations, inheritIdentity, initialiseMemberPositionInformation, isCacheable, isDescendantOf, isDetachable, isEmbeddedOnly, isExcludeDefaultListeners, isExcludeSuperClassListeners, isImplementationOfPersistentDefinition, isInstantiable, isMappedSuperclass, isMetaDataComplete, isRequiresExtent, isRootInstantiableClass, isSameOrAncestorOf, isSerializeRead, isVersioned, loadClass, newFetchGroupMetaData, newFieldMetadata, newForeignKeyMetadata, newIdentityMetadata, newIndexMetadata, newInheritanceMetadata, newJoinMetaData, newPrimaryKeyMetadata, newPropertyMetadata, newQueryMetadata, newStoredProcQueryMetadata, newUniqueMetadata, newUnmappedColumnMetaData, newVersionMetadata, pkIsDatastoreAttributed, setAccessViaField, setCacheable, setCacheable, setCatalog, setDetachable, setDetachable, setEmbeddedOnly, setEmbeddedOnly, setEntityName, setIdentityMetaData, setIdentityType, setInheritanceMetaData, setMappedSuperclass, setMetaDataComplete, setObjectIdClass, setPersistenceModifier, setPrimaryKeyMetaData, setRequiresExtent, setRequiresExtent, setSchema, setSerializeRead, setTable, setVersionMetaData, usesSingleFieldIdentityClass, validateObjectIdClass, validateUnmappedColumns, validateUserInputForIdentity, validateUserInputForInheritanceMetaData

Methods inherited from class org.datanucleus.metadata.MetaData

addExtension, addExtension, getExtensions, getNoOfExtensions, getParent, getValueForExtension, getValuesForExtension, hasExtension, isInitialised, isPopulated, isUsed, newExtensionMetaData, removeExtension, setParent, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

InterfaceMetaData

public InterfaceMetaData(PackageMetaData parent,
                         String name)

Constructor. Takes the basic string information found in the MetaData file.

Parameters:

parent - The package to which this class belongs

name - Name of class

Method Detail

initialise

public void initialise(ClassLoaderResolver clr,
                       MetaDataManager mmgr)

Method to initialise the object, creating internal convenience arrays. Initialises all sub-objects. If populate() is going to be used it should be used BEFORE calling this method.

Specified by:

initialise in class AbstractClassMetaData

Parameters:

clr - ClassLoader resolver

mmgr - MetaData manager

populate

public void populate(ClassLoaderResolver clr,
                     ClassLoader primary,
                     MetaDataManager mmgr)

Method to provide the details of the class being represented by this MetaData. This can be used to firstly provide defaults for attributes that aren't specified in the MetaData, and secondly to report any errors with attributes that have been specified that are inconsistent with the class being represented.

One possible use of this method would be to take a basic ClassMetaData for a class and call this, passing in the users class. This would then add AbstractMemberMetaData for all fields in this class providing defaults for all of these.

Specified by:

populate in class AbstractClassMetaData

Parameters:

clr - ClassLoaderResolver to use in loading any classes

primary - the primary ClassLoader to use (or null)

mmgr - MetaData manager

newDefaultedProperty

protected AbstractMemberMetaData newDefaultedProperty(String name)

Utility to add a defaulted PropertyMetaData to the class. Provided as a method since then any derived classes can override it.

Overrides:

newDefaultedProperty in class AbstractClassMetaData

Parameters:

name - name of field

Returns:

the new PropertyMetaData

populatePropertyMetaData

protected void populatePropertyMetaData(ClassLoaderResolver clr,
                                        Class cls,
                                        boolean pkFields,
                                        ClassLoader primary,
                                        MetaDataManager mmgr)

Populate PropertyMetaData.

Parameters:

clr - The ClassLoader

cls - This class

pkFields - Process pk fields (or non-PK fields if false)

primary - the primary ClassLoader to use (or null)

mmgr - MetaData manager

Throws:

InvalidMetaDataException - if the Class for a declared type in a field cannot be loaded by the clr

InvalidMetaDataException - if a field declared in the MetaData does not exist in the Class

addMetaDataForMembersNotInMetaData

protected void addMetaDataForMembersNotInMetaData(Class cls)

Add MetaData for properties of the interface not declared in MetaData.

Parameters:

cls - Class represented by this metadata

toString

public String toString(String prefix,
                       String indent)

Returns a string representation of the object. This can be used as part of a facility to output a MetaData file.

Overrides:

toString in class MetaData

Parameters:

prefix - prefix string

indent - indent string

Returns:

a string representation of the object.