Java Doc for AbstractClassMetaData.java in » Database-ORM » JPOX » org » jpox » metadata » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Database ORM » JPOX » org.jpox.metadata

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

org.jpox.metadata .MetaData

org.jpox.metadata .AbstractClassMetaData

All known Subclasses:   org.jpox.metadata .InterfaceMetaData,  org.jpox.metadata .ClassMetaData,
AbstractClassMetaData
abstract public class AbstractClassMetaData extends MetaData (Code)
Abstract representation of the MetaData of a class/interface. Has a parent PackageMetaData that can contain the metadata for several classes/interfaces. Is extended by ClassMetaData and InterfaceMetaData. Of the things that it contains the main one are the "members" which are the MetaData for all fields and properties that are persistable.
since:
   1.1
version:
   $Revision: 1.98 $

Field Summary
protected static Localiser LOCALISER_API

protected int[] allMemberPositions
     Positions of all fields/properties (inc superclasses).
protected String catalog
     Catalog name (O/R mapping).
protected boolean detachable
     detachable tag value.
protected boolean[] dfgMemberFlags
     Flags of the default-fetch-group state for all fields/properties.
protected int[] dfgMemberPositions
     Positions of the default-fetch-group fields/properties (inc superclasses).
protected boolean embeddedOnly
     embedded-only tag value.
protected String entityName
     Entity name.
protected Boolean excludeDefaultListeners
     Flag to exclude default listeners.
protected Boolean excludeSuperClassListeners
     Flag to exclude superclass listeners.
protected FetchGroupMetaData[] fetchGroupMetaData
     Fetch Groups for this class.
protected Map fetchGroupMetaDataByName
     Convenience lookup map of fetch group by the name.
protected List fetchGroups

protected ForeignKeyMetaData[] foreignKeyMetaData

protected List foreignKeys

final protected String fullName

protected IdentityMetaData identityMetaData

protected boolean identitySpecified
     Flag whether the identity was specified by the user.
protected IdentityType identityType
     Identity-type tag value.
protected boolean implementationOfPersistentDefinition

protected IndexMetaData[] indexMetaData

protected List indexes

protected InheritanceMetaData inheritanceMetaData

protected JoinMetaData[] joinMetaData

protected List joins

protected List listeners
     EventListeners.
protected AbstractMemberMetaData[] managedMembers
     Managed fields/properties of this class.
protected int memberCount
     number of managed fields/properties from this class plus inherited classes.
protected Map memberPositionsByName
     Position numbers of members mapped by the name of the field/property.
protected List members
     List of members (fields/properties).
protected boolean metaDataComplete
     Flag for whether the MetaData here is complete without annotations.
final protected String name

protected int noOfInheritedManagedMembers
     No of managed fields/properties in superclasses, that are inherited by this class.
protected boolean[] nonPkMemberFlags
     Flags of the non-primary key fields/properties (inc superclasses).
protected int[] nonPkMemberPositions
     Positions of the non-primary-key fields/properties (inc superclasses).
protected String objectidClass
     objectid-class tag value.
protected AbstractMemberMetaData[] overriddenMembers
     Fields/properties for superclasses that are overridden in this class.
protected AbstractClassMetaData pcSuperclassMetaData

protected int[] persistenceCapableMemberPositions
     Postions of the PersistenceCapable fields/properties (inc superclasses).
protected String persistenceCapableSuperclass
     persistence-capable-superclass tag value (deprecated).
protected ClassPersistenceModifier persistenceModifier
     persistence-modifier tag value.
protected transient boolean persistentInterfaceImplNeedingTableFromSubclass
     Implementation of "persistent-interface" needing table setting from subclass.
protected transient boolean persistentInterfaceImplNeedingTableFromSuperclass
     Implementation of "persistent-interface" needing table setting from superclass.
protected int[] pkMemberPositions
     Positions of the primary-key fields/properties (inc superclasses).
protected PrimaryKeyMetaData primaryKeyMetaData

protected Collection queries

protected Collection queryResultMetaData
     List of query result MetaData defined for this file.
int[] relationPositions
     Absolute positions of the fields/properties that have relations.
protected boolean requiresExtent
     requires-extent tag value.
protected String schema
     Schema name (O/R mapping).
protected boolean[] scoMutableMemberFlags
     Flags of the SCO mutable state for all fields/properties.
protected int[] scoMutableMemberPositions
     Positions of the SCO mutable fields/properties (inc superclasses).
protected int[] scoNonContainerMemberPositions
     Field numbers of all SCO fields/properties that arent containers.
protected int[] secondClassContainerMemberPositions
     Positions of all SCO fields/properties that are containers.
protected String table
     Table name (O/R mapping).
protected List uniqueConstraints

protected UniqueMetaData[] uniqueMetaData

protected List unmappedColumns
     The columns that are present in the datastore yet not mapped to fields in this class.
protected boolean usesSingleFieldIdentityClass

protected VersionMetaData versionMetaData


Constructor Summary
protected AbstractClassMetaData(PackageMetaData parent, String name, String identityType, String objectidClass, String requiresExtent, String detachable, String embeddedOnly, String modifier, String persistenceCapableSuperclass, String catalog, String schema, String table, String entityName)
     Constructor.
public AbstractClassMetaData(InterfaceMetaData imd, String implClassName, boolean copyMembers)
     Constructor for creating the ClassMetaData for an implementation of a "persistent-interface".
public AbstractClassMetaData(ClassMetaData cmd, String implClassName)
     Constructor for creating the ClassMetaData for an implementation of a "persistent-abstract-class".

Method Summary
public void addFetchGroup(FetchGroupMetaData fgmd)
     Method to add a fetch-group to this class.
public void addForeignKey(ForeignKeyMetaData fkmd)
     Method to add an foreign-key to this class.
public void addIndex(IndexMetaData idxmd)
     Method to add an index to this class.
public void addJoin(JoinMetaData jnmd)
     Method to add a join to this class.
public void addListener(EventListenerMetaData listener)
     Add a listener class name
Parameters:
  listener - the listener metadata.
public void addMember(AbstractMemberMetaData mmd)
     Method to add a field/property to this interface.
public void addQuery(QueryMetaData qmd)
     Method to add a named query to this class.
public void addQueryResultMetaData(QueryResultMetaData resultMetaData)
     Method to register a query-result MetaData.
public void addUniqueConstraint(UniqueMetaData unimd)
     Method to add a unique constraint to this class.
final public void addUnmappedColumn(ColumnMetaData colmd)
     Method to add an unmapped column.
protected void checkInitialised()
     Method to check whether the Meta-Data has been initialised.
throws:
  JDOFatalInternalException - Thrown if the Meta-Data hasn't been initialised.
protected void checkPopulated()
     Method to check whether the Meta-Data has been populated.
throws:
  JPOXException - Thrown if the Meta-Data hasn't been populated.
protected void copyMembersFromInterface(InterfaceMetaData imd)
     Convenience method to copy the properties from an existing interface.
protected void determineIdentity()

protected void determineInheritanceMetaData()
     Impose a default inheritance strategy when one is not already specified.
protected void determineObjectIdClass(ClassLoaderResolver clr)

protected void determineSuperClassName(ClassLoaderResolver clr, Class cls)
     Determine the super PersistenceCapable class. The persistence-capable-superclass attribute is deprecated for JDO2.0.
public void excludeDefaultListeners()
     Method to exclude default listeners.
public void excludeSuperClassListeners()

public int getAbsoluteMemberPositionForRelativePosition(int relativePosition)
     Accessor for the absolute position for a relative position.
public int getAbsolutePositionOfMember(String memberName)
     Accessor for the absolute position of the field/property with the specified name.
public int getAbsolutePositionOfMember(String className, String memberName)
     Accessor for the absolute position of the field/property with the specified name.
public int[] getAllMemberPositions()
     Accessor for all field/property positions.
public AbstractClassMetaData getBaseAbstractClassMetaData()
     Convenience accessor for the AbstractClassMetaData of the base object in this hierarchy.
public int[] getBidirectionalRelationMemberPositions(ClassLoaderResolver clr)
     Convenience method to return the absolute positions of fields/properties that have bidirectional relations.
public String getCatalog()
     Accessor for the catalog name.
public boolean[] getDFGMemberFlags()
     Accessor for the flags of the DFG fields/properties (inc superclass).
public int[] getDFGMemberPositions()
     Accessor for the absolute positions of the default fetch group fields/properties (inc superclasses).
final public DiscriminatorMetaData getDiscriminatorMetaDataForTable()
     Convenience method to find the discriminator MetaData defining the discrim for the same table as this class is using.
final public DiscriminatorStrategy getDiscriminatorStrategy()
     Convenience accessor for the discriminator strategy applying to this class.
public String getEntityName()
     Accessor for the class name.
final public FetchGroupMetaData[] getFetchGroupMetaData()
     Accessor for all MetaData defined for fetch groups for this class.
public FetchGroupMetaData[] getFetchGroupMetaData(Collection groupNames)
     Accessor for fetch group metadata for the specified groups (if present).
public FetchGroupMetaData getFetchGroupMetaData(String groupname)
     Accessor for the fetch group metadata for the group specified.
final public ForeignKeyMetaData[] getForeignKeyMetaData()

public String getFullClassName()
     Accessor for the full class name.
final public IdentityMetaData getIdentityMetaData()

public IdentityType getIdentityType()
     Accessor for the identity-type.
final public IndexMetaData[] getIndexMetaData()

final public InheritanceMetaData getInheritanceMetaData()

final public JoinMetaData[] getJoinMetaData()

public EventListenerMetaData getListenerForClass(String className)

public List getListeners()

public AbstractMemberMetaData[] getManagedMembers()
     Accessor for the managed fields/properties in this class (not including superclass, but including overridden).
protected AbstractMemberMetaData getMemberBeingOverridden(String name)
     Convenience method that navigates up a MetaData inheritance tree until it finds the base field/property definition.
public int getMemberCount()
     Accessor for the number of managed fields/properties from this class plus inherited classes.
public AbstractMemberMetaData getMetaDataForManagedMemberAtAbsolutePosition(int abs_position)
     Accessor for a managed field/property including superclass fields.
Parameters:
  abs_position - The position of the managed member including thesuperclass.
protected AbstractMemberMetaData getMetaDataForManagedMemberAtAbsolutePositionInternal(int abs_position)
     Internal method to get the field/property for an absolute field number. If the field for that absolute field position is overridden by a field in this class then this field/property will be returned.
Parameters:
  abs_position - The position of the managed field including thesuperclass.
public AbstractMemberMetaData getMetaDataForManagedMemberAtPosition(int position)
     Accessor for MetaData for a managed field/property in this class.
public AbstractMemberMetaData getMetaDataForMember(String name)
     Accessor for the Meta-Data for a field/property.
public AbstractMemberMetaData getMetaDataForMemberAtRelativePosition(int index)
     Accessor for the metadata of a field/property.
public MetaDataManager getMetaDataManager()
     Convenience accessor for the MetaData Manager in use.
public String getName()
     Accessor for the class name.
public int getNoOfInheritedManagedMembers()
     Accessor for the number of inherited managed fields/properties in superclasses.
public int getNoOfManagedMembers()
     Accessor for the number of managed fields/properties (this class only).
public int getNoOfMembers()
     Accessor for the number of fields/properties.
public int getNoOfOverriddenMembers()
     Accessor for the number of overridden fields/properties (this class only).
public int getNoOfPrimaryKeyMembers()
     Accessor for the number of primary key fields/properties.
public int getNoOfQueries()
     Accessor for the number of named queries.
public boolean[] getNonPKMemberFlags()
     Accessor for the flags of the non primary key fields/properties (inc superclass members).
public int[] getNonPKMemberPositions()
     Accessor for the positions of the non primary key fields/properties (inc superclass fields).
public String getObjectidClass()
     Accessor for the objectid-class tag value.
public AbstractMemberMetaData getOverriddenMember(int position)
     Accessor for MetaData for an overridden field/property in this class.
Parameters:
  position - The position of the overridden field/property.
public AbstractMemberMetaData getOverriddenMember(String name)
     Accessor for an overridden field/property with the specified name.
public AbstractMemberMetaData[] getOverriddenMembers()
     Accessor for the overridden fields/properties in this class.
public int[] getPKMemberPositions()
     Accessor for the field numbers of the primary key fields/properties.
public PackageMetaData getPackageMetaData()
     Convenience accessor for the parent Package MetaData.
public String getPackageName()
     Convenience accessor for the package name.
public int[] getPersistenceCapableMemberPositions()
     Accessor for the absolute positions of the PersistenceCapable fields/properties.
public String getPersistenceCapableSuperclass()
     Accessor for the persistence-capable-superclass tag value.
public ClassPersistenceModifier getPersistenceModifier()
     Accessor for the persistence-modifier of the class.
public String[] getPrimaryKeyMemberNames()
     Accessor for the names of the primary key fields/properties.
final public PrimaryKeyMetaData getPrimaryKeyMetaData()

public QueryMetaData[] getQueries()
     Accessor for the metadata of the named queries.
public QueryResultMetaData[] getQueryResultMetaData()
     Get the query result MetaData registered for this class.
void getReferencedClassMetaData(List orderedCMDs, Set referencedCMDs, String dba_vendor_id, ClassLoaderResolver clr)
     Method to return the ClassMetaData records for classes referenced by this object.
public int[] getRelationMemberPositions(ClassLoaderResolver clr)
     Convenience method to return the absolute positions of all fields/properties that have relations.
public int getRelativePositionOfMember(String memberName)
     Accessor for the position of the field/property with the specified name.
public int[] getSCOContainerMemberPositions()
     Accessor for the absolute positions of all SCO fields/properties that are containers.
public boolean[] getSCOMutableMemberFlags()
     Accessor for the flags of the SCO mutable fields (inc superclass fields).
public int[] getSCOMutableMemberPositions()
     Accessor for the absolute positions of the second class mutable fields/properties.
public int[] getSCONonContainerMemberPositions()

public String getSchema()
     Accessor for the schema name.
public AbstractClassMetaData getSuperAbstractClassMetaData()
     Accessor for the Meta-Data for the superclass of this class.
public String getTable()
     Accessor for the table name.
final public UniqueMetaData[] getUniqueMetaData()

final public List getUnmappedColumns()
     Accessor for the unmapped columns require for the datastore table.
final public VersionMetaData getVersionMetaData()

final public VersionMetaData getVersionMetaDataForTable()
     Convenience method to find the version MetaData defining versioning for the same table as this class is using.
public boolean hasMember(String memberName)
     Method to check if a field/property exists in this classes definition.
public boolean hasRelations(ClassLoaderResolver clr)
     Convenience method to return if the class has relations to other objects.
protected void inheritDetachableSettings()
     Inherit detach settings from super classes.
protected void inheritIdentity()
     Inherit the identity definition from super classes.
abstract public void initialise()
     Method to initialise the sub-objects of this class metadata.
public boolean isDetachable()
     Accessor for the detachable tag value.
public boolean isEmbeddedOnly()
     Accessor for the embedded-only tag value.
public boolean isExcludeDefaultListeners()

public boolean isExcludeSuperClassListeners()

public boolean isImplementationOfPersistentDefinition()
     Return whether this MetaData is for an implementation of a persistent definition.
public boolean isMetaDataComplete()
     Accessor for whether this class is fully specified by this metadata and that any annotations should be ignored.
public boolean isRequiresExtent()
     Accessor for the requires-extent tag value.
public boolean isSameOrAncestorOf(AbstractClassMetaData cmd)
     Check if the argument cmd is the same as this or a descedent.
protected Class loadClass(ClassLoaderResolver clr, ClassLoader primary)

protected AbstractMemberMetaData newDefaultedProperty(String name)
     Utility to add a defaulted PropertyMetaData to the class.
abstract public void populate(ClassLoaderResolver clr, ClassLoader primary)
     Method to provide the details of the class being represented by this MetaData.
final public void setCatalog(String catalog)
     Mutator for the catalog name.
public void setEmbeddedOnly()
     Convenience method to make this class available for storing only when embedded in another object.
final public void setIdentityMetaData(IdentityMetaData identityMetaData)
     Mutator for the identity MetaData.
public void setIdentityType(IdentityType type)
     Cinvenience method for updating the identity type when not set correctly during construction.
final public void setInheritanceMetaData(InheritanceMetaData inheritanceMetaData)
     Mutator for the inheritance MetaData.
public void setMetaDataComplete()
     Method to set that this class is "metadata complete" (see JPA spec).
final public void setObjectIdClass(String objectidClass)
     Mutator for the object id class name.
final public void setPrimaryKeyMetaData(PrimaryKeyMetaData primaryKeyMetaData)
     Mutator for the PrimaryKey MetaData.
final public void setSchema(String schema)
     Mutator for the schema name.
final public void setTable(String table)
     Mutator for the table name.
final public void setVersionMetaData(VersionMetaData versionMetaData)
     Mutator for the Version MetaData.
public boolean usesSingleFieldIdentityClass()

protected void validateDeprecatedMetaData()

protected void validateUnmappedColumns()
     Convenience method to validate the specified "unmapped" columns.
protected void validateUserInputForIdentity()

protected void validateUserInputForInheritanceMetaData()
     Check if the inheritance MetaData is credible.

Field Detail
LOCALISER_API
protected static Localiser LOCALISER_API(Code)

allMemberPositions
protected int[] allMemberPositions(Code)
Positions of all fields/properties (inc superclasses).

catalog
protected String catalog(Code)
Catalog name (O/R mapping).

detachable
protected boolean detachable(Code)
detachable tag value.

dfgMemberFlags
protected boolean[] dfgMemberFlags(Code)
Flags of the default-fetch-group state for all fields/properties.

dfgMemberPositions
protected int[] dfgMemberPositions(Code)
Positions of the default-fetch-group fields/properties (inc superclasses).

embeddedOnly
protected boolean embeddedOnly(Code)
embedded-only tag value.

entityName
protected String entityName(Code)
Entity name. Required by JPA1 �4.3.1 for accessing this class in queries.

excludeDefaultListeners
protected Boolean excludeDefaultListeners(Code)
Flag to exclude default listeners.

excludeSuperClassListeners
protected Boolean excludeSuperClassListeners(Code)
Flag to exclude superclass listeners.

fetchGroupMetaData
protected FetchGroupMetaData[] fetchGroupMetaData(Code)
Fetch Groups for this class. Available to be used in queries and when detaching.

fetchGroupMetaDataByName
protected Map fetchGroupMetaDataByName(Code)
Convenience lookup map of fetch group by the name.

fetchGroups
protected List fetchGroups(Code)
List of fetch-group

foreignKeyMetaData
protected ForeignKeyMetaData[] foreignKeyMetaData(Code)
ForeignKeyMetaData

foreignKeys
protected List foreignKeys(Code)
List of foreign-key

fullName
final protected String fullName(Code)
Full name (e.g org.jpox.MyClass)

identityMetaData
protected IdentityMetaData identityMetaData(Code)
Identity MetaData

identitySpecified
protected boolean identitySpecified(Code)
Flag whether the identity was specified by the user.

identityType
protected IdentityType identityType(Code)
Identity-type tag value.

implementationOfPersistentDefinition
protected boolean implementationOfPersistentDefinition(Code)

indexMetaData
protected IndexMetaData[] indexMetaData(Code)
IndexMetaData

indexes
protected List indexes(Code)
List of indexes

inheritanceMetaData
protected InheritanceMetaData inheritanceMetaData(Code)
Inheritance MetaData

joinMetaData
protected JoinMetaData[] joinMetaData(Code)
JoinMetaData

joins
protected List joins(Code)
List of joins

listeners
protected List listeners(Code)
EventListeners. Use a list to preserve ordering.

managedMembers
protected AbstractMemberMetaData[] managedMembers(Code)
Managed fields/properties of this class. Contains the same AbstractMemberMetaData objects as are in "members". Doesnt include any overridden members which are stored separately. All fields will return true to "fmd.isJdoField()".

memberCount
protected int memberCount(Code)
number of managed fields/properties from this class plus inherited classes.

memberPositionsByName
protected Map memberPositionsByName(Code)
Position numbers of members mapped by the name of the field/property.

members
protected List members(Code)
List of members (fields/properties).

metaDataComplete
protected boolean metaDataComplete(Code)
Flag for whether the MetaData here is complete without annotations. Used by JPA.

name
final protected String name(Code)
Class name

noOfInheritedManagedMembers
protected int noOfInheritedManagedMembers(Code)
No of managed fields/properties in superclasses, that are inherited by this class.

nonPkMemberFlags
protected boolean[] nonPkMemberFlags(Code)
Flags of the non-primary key fields/properties (inc superclasses).

nonPkMemberPositions
protected int[] nonPkMemberPositions(Code)
Positions of the non-primary-key fields/properties (inc superclasses).

objectidClass
protected String objectidClass(Code)
objectid-class tag value.

overriddenMembers
protected AbstractMemberMetaData[] overriddenMembers(Code)
Fields/properties for superclasses that are overridden in this class.

pcSuperclassMetaData
protected AbstractClassMetaData pcSuperclassMetaData(Code)
Class MetaData for the Persistence-Capable superclass (if any)

persistenceCapableMemberPositions
protected int[] persistenceCapableMemberPositions(Code)
Postions of the PersistenceCapable fields/properties (inc superclasses).

persistenceCapableSuperclass
protected String persistenceCapableSuperclass(Code)
persistence-capable-superclass tag value (deprecated).

persistenceModifier
protected ClassPersistenceModifier persistenceModifier(Code)
persistence-modifier tag value.

persistentInterfaceImplNeedingTableFromSubclass
protected transient boolean persistentInterfaceImplNeedingTableFromSubclass(Code)
Implementation of "persistent-interface" needing table setting from subclass.

persistentInterfaceImplNeedingTableFromSuperclass
protected transient boolean persistentInterfaceImplNeedingTableFromSuperclass(Code)
Implementation of "persistent-interface" needing table setting from superclass.

pkMemberPositions
protected int[] pkMemberPositions(Code)
Positions of the primary-key fields/properties (inc superclasses).

primaryKeyMetaData
protected PrimaryKeyMetaData primaryKeyMetaData(Code)
PrimaryKey MetaData

queries
protected Collection queries(Code)
Named queries

queryResultMetaData
protected Collection queryResultMetaData(Code)
List of query result MetaData defined for this file.

relationPositions
int[] relationPositions(Code)
Absolute positions of the fields/properties that have relations.

requiresExtent
protected boolean requiresExtent(Code)
requires-extent tag value.

schema
protected String schema(Code)
Schema name (O/R mapping).

scoMutableMemberFlags
protected boolean[] scoMutableMemberFlags(Code)
Flags of the SCO mutable state for all fields/properties.

scoMutableMemberPositions
protected int[] scoMutableMemberPositions(Code)
Positions of the SCO mutable fields/properties (inc superclasses).

scoNonContainerMemberPositions
protected int[] scoNonContainerMemberPositions(Code)
Field numbers of all SCO fields/properties that arent containers.

secondClassContainerMemberPositions
protected int[] secondClassContainerMemberPositions(Code)
Positions of all SCO fields/properties that are containers.

table
protected String table(Code)
Table name (O/R mapping). This may be of the form "[database].[catalog].[schema].table"

uniqueConstraints
protected List uniqueConstraints(Code)
List of uniqueConstraints

uniqueMetaData
protected UniqueMetaData[] uniqueMetaData(Code)
UniqueMetaData

unmappedColumns
protected List unmappedColumns(Code)
The columns that are present in the datastore yet not mapped to fields in this class.

usesSingleFieldIdentityClass
protected boolean usesSingleFieldIdentityClass(Code)
if this PersistenceCapable class uses SingleFieldIdentity

versionMetaData
protected VersionMetaData versionMetaData(Code)
Version MetaData

Constructor Detail
AbstractClassMetaData
protected AbstractClassMetaData(PackageMetaData parent, String name, String identityType, String objectidClass, String requiresExtent, String detachable, String embeddedOnly, String modifier, String persistenceCapableSuperclass, String catalog, String schema, String table, String entityName)(Code)
Constructor. Takes the basic string information found in an XML MetaData file.
Parameters:
  parent - The package to which this class/interface belongs
Parameters:
  name - Name of class
Parameters:
  identityType - identity-type flag
Parameters:
  objectidClass - Primary key class name
Parameters:
  requiresExtent - Whether the class requires an extent
Parameters:
  detachable - Whether the class can be detached
Parameters:
  embeddedOnly - embedded-only tag
Parameters:
  modifier - persistence-modifier tag
Parameters:
  catalog - The catalog name default for this class
Parameters:
  schema - The schema name default for this class
Parameters:
  table - table to store the class in
Parameters:
  entityName - the entity name required by JPA �4.3.1

AbstractClassMetaData
public AbstractClassMetaData(InterfaceMetaData imd, String implClassName, boolean copyMembers)(Code)
Constructor for creating the ClassMetaData for an implementation of a "persistent-interface".
Parameters:
  imd - MetaData for the "persistent-interface"
Parameters:
  implClassName - Name of the implementation class
Parameters:
  copyMembers - Whether to copy the fields/properties of the interface too

AbstractClassMetaData
public AbstractClassMetaData(ClassMetaData cmd, String implClassName)(Code)
Constructor for creating the ClassMetaData for an implementation of a "persistent-abstract-class".
Parameters:
  cmd - MetaData for the implementation of the "persistent-abstract-class"
Parameters:
  implClassName - Name of the implementation class

Method Detail
addFetchGroup
public void addFetchGroup(FetchGroupMetaData fgmd)(Code)
Method to add a fetch-group to this class.
Parameters:
  fgmd - Meta-Data for the fetch-group.

addForeignKey
public void addForeignKey(ForeignKeyMetaData fkmd)(Code)
Method to add an foreign-key to this class.
Parameters:
  fkmd - Meta-Data for the foreign-key.

addIndex
public void addIndex(IndexMetaData idxmd)(Code)
Method to add an index to this class.
Parameters:
  idxmd - Meta-Data for the index.

addJoin
public void addJoin(JoinMetaData jnmd)(Code)
Method to add a join to this class. Rejects the addition of duplicate named fields.
Parameters:
  jnmd - Meta-Data for the join.

addListener
public void addListener(EventListenerMetaData listener)(Code)
Add a listener class name
Parameters:
  listener - the listener metadata. Duplicated classes are ignored

addMember
public void addMember(AbstractMemberMetaData mmd)(Code)
Method to add a field/property to this interface. Rejects the addition of duplicate named fields/properties.
Parameters:
  mmd - Field/Property MetaData

addQuery
public void addQuery(QueryMetaData qmd)(Code)
Method to add a named query to this class. Rejects the addition of duplicate named queries.
Parameters:
  qmd - Meta-Data for the query.

addQueryResultMetaData
public void addQueryResultMetaData(QueryResultMetaData resultMetaData)(Code)
Method to register a query-result MetaData.
Parameters:
  resultMetaData - Query-Result MetaData to register

addUniqueConstraint
public void addUniqueConstraint(UniqueMetaData unimd)(Code)
Method to add a unique constraint to this class.
Parameters:
  unimd - Meta-Data for the unique constraint.

addUnmappedColumn
final public void addUnmappedColumn(ColumnMetaData colmd)(Code)
Method to add an unmapped column.
Parameters:
  colmd - The metadata for the unmapped column

checkInitialised
protected void checkInitialised()(Code)
Method to check whether the Meta-Data has been initialised.
throws:
  JDOFatalInternalException - Thrown if the Meta-Data hasn't been initialised.

checkPopulated
protected void checkPopulated()(Code)
Method to check whether the Meta-Data has been populated.
throws:
  JPOXException - Thrown if the Meta-Data hasn't been populated.

copyMembersFromInterface
protected void copyMembersFromInterface(InterfaceMetaData imd)(Code)
Convenience method to copy the properties from an existing interface. Adds FieldMetaData for each PropertyMetaData on the persistent-interface.
Parameters:
  imd - The interface that we copy from

determineIdentity
protected void determineIdentity()(Code)
Determines the identity based on MetaData defaults or user defined MetaData

determineInheritanceMetaData
protected void determineInheritanceMetaData()(Code)
Impose a default inheritance strategy when one is not already specified. Uses the PMF property for defaultInheritanceStrategy and works to the JDO2 spec etc.

determineObjectIdClass
protected void determineObjectIdClass(ClassLoaderResolver clr)(Code)
Determine the object id class
Parameters:
  clr - the ClassLoader
throws:
  InvalidMetaDataException - if the class 0 or more that one primary key field and no objectid-classhas been declared in the MetaData
throws:
  InvalidMetaDataException - if the objectid-class has not been set and the primary key field doesnot match a supported SingleFieldIdentity
throws:
  InvalidMetaDataException - if the identity type is APPLICATION but not primary key fields have been set
throws:
  InvalidMetaDataException - if the objectid-class cannot be loaded by the clr

determineSuperClassName
protected void determineSuperClassName(ClassLoaderResolver clr, Class cls)(Code)
Determine the super PersistenceCapable class. The persistence-capable-superclass attribute is deprecated for JDO2.0. The attribute will be ignored so metadata files from previous releases can be used. The persistenceCapableSuperclass we use will be retrieved from the class itself.
Parameters:
  clr - The ClassLoaderResolver
Parameters:
  cls - This class
throws:
  InvalidMetaDataException - if the declared persistence-capable-superclass super class cannot be loaded by the clr.
throws:
  InvalidMetaDataException - if the declared persistence-capable-superclass hasno reachable MetaData

excludeDefaultListeners
public void excludeDefaultListeners()(Code)
Method to exclude default listeners.

excludeSuperClassListeners
public void excludeSuperClassListeners()(Code)
Toogle exclude super class listeners

getAbsoluteMemberPositionForRelativePosition
public int getAbsoluteMemberPositionForRelativePosition(int relativePosition)(Code)
Accessor for the absolute position for a relative position.
Parameters:
  relativePosition - The relative field number The absolute position

getAbsolutePositionOfMember
public int getAbsolutePositionOfMember(String memberName)(Code)
Accessor for the absolute position of the field/property with the specified name. The absolute position has origin of the root superclass, starting at 0.
Parameters:
  memberName - Name of the field/property Absolute position of the field/property.

getAbsolutePositionOfMember
public int getAbsolutePositionOfMember(String className, String memberName)(Code)
Accessor for the absolute position of the field/property with the specified name. The absolute position has origin of the root superclass, starting at 0. Will only retrieve the absolute field number if the field_name is of type given by class_name.
Parameters:
  className - Name of the class
Parameters:
  memberName - Name of the field/property Absolute position of the field/property.

getAllMemberPositions
public int[] getAllMemberPositions()(Code)
Accessor for all field/property positions. These are absolute numbers and include superclasses and are really just 0, 1, 2, ... n. The positions of all (managed) fields/properties.

getBaseAbstractClassMetaData
public AbstractClassMetaData getBaseAbstractClassMetaData()(Code)
Convenience accessor for the AbstractClassMetaData of the base object in this hierarchy. The AbstractClassMetaData for the base object.

getBidirectionalRelationMemberPositions
public int[] getBidirectionalRelationMemberPositions(ClassLoaderResolver clr)(Code)
Convenience method to return the absolute positions of fields/properties that have bidirectional relations.
Parameters:
  clr - ClassLoader resolver Absolute positions of bidirectional relation fields/properties

getCatalog
public String getCatalog()(Code)
Accessor for the catalog name. catalog name

getDFGMemberFlags
public boolean[] getDFGMemberFlags()(Code)
Accessor for the flags of the DFG fields/properties (inc superclass). The flags whether the field/property is in the DFG

getDFGMemberPositions
public int[] getDFGMemberPositions()(Code)
Accessor for the absolute positions of the default fetch group fields/properties (inc superclasses). The positions of the DFG fields/properties (inc superclasses).

getDiscriminatorMetaDataForTable
final public DiscriminatorMetaData getDiscriminatorMetaDataForTable()(Code)
Convenience method to find the discriminator MetaData defining the discrim for the same table as this class is using. Traverses up the inheritance tree to find the highest class that uses "subclass-table" that has discriminator metadata defined, and returns the MetaData. DiscriminatorMetaData for the highest class in this tree using subclass-table

getDiscriminatorStrategy
final public DiscriminatorStrategy getDiscriminatorStrategy()(Code)
Convenience accessor for the discriminator strategy applying to this class. This is specified on the class managing the table if at all. The discriminator strategy

getEntityName
public String getEntityName()(Code)
Accessor for the class name. class name

getFetchGroupMetaData
final public FetchGroupMetaData[] getFetchGroupMetaData()(Code)
Accessor for all MetaData defined for fetch groups for this class. This doesn't include superclasses. Returns the fetchGroupMetaData.

getFetchGroupMetaData
public FetchGroupMetaData[] getFetchGroupMetaData(Collection groupNames)(Code)
Accessor for fetch group metadata for the specified groups (if present). The returned metadata is what is defined for this class that matches any of the names in the input set.
Parameters:
  groupNames - Names of the fetch groups MetaData for the groups

getFetchGroupMetaData
public FetchGroupMetaData getFetchGroupMetaData(String groupname)(Code)
Accessor for the fetch group metadata for the group specified.
Parameters:
  groupname - Name of the fetch group MetaData for this group

getForeignKeyMetaData
final public ForeignKeyMetaData[] getForeignKeyMetaData()(Code)
Accessor for foreignKeyMetaData Returns the foreignKeyMetaData.

getFullClassName
public String getFullClassName()(Code)
Accessor for the full class name. full class name.

getIdentityMetaData
final public IdentityMetaData getIdentityMetaData()(Code)
Accessor for identityMetaData Returns the identityMetaData.

getIdentityType
public IdentityType getIdentityType()(Code)
Accessor for the identity-type. identity-type tag value

getIndexMetaData
final public IndexMetaData[] getIndexMetaData()(Code)
Accessor for indexMetaData Returns the indexMetaData.

getInheritanceMetaData
final public InheritanceMetaData getInheritanceMetaData()(Code)
Accessor for inheritanceMetaData Returns the inheritanceMetaData.

getJoinMetaData
final public JoinMetaData[] getJoinMetaData()(Code)
Accessor for joinMetaData Returns the joinMetaData.

getListenerForClass
public EventListenerMetaData getListenerForClass(String className)(Code)
Accessor for the EventListener info for an EventListener class name
Parameters:
  className - Name of the event listener class EventListener info for this class (or null if the class isnt an EventListener)

getListeners
public List getListeners()(Code)
Get the event listeners the event listeners

getManagedMembers
public AbstractMemberMetaData[] getManagedMembers()(Code)
Accessor for the managed fields/properties in this class (not including superclass, but including overridden). MetaData for the managed fields/properties in this class

getMemberBeingOverridden
protected AbstractMemberMetaData getMemberBeingOverridden(String name)(Code)
Convenience method that navigates up a MetaData inheritance tree until it finds the base field/property definition.
Parameters:
  name - Name of the field/property we require The AbstractMemberMetaData

getMemberCount
public int getMemberCount()(Code)
Accessor for the number of managed fields/properties from this class plus inherited classes. The number of managed fields/properties from this class plus inherited classes.

getMetaDataForManagedMemberAtAbsolutePosition
public AbstractMemberMetaData getMetaDataForManagedMemberAtAbsolutePosition(int abs_position)(Code)
Accessor for a managed field/property including superclass fields.
Parameters:
  abs_position - The position of the managed member including thesuperclass. Fields are numbered from 0 in the root superclass. The managed field/property at this "absolute" position.

getMetaDataForManagedMemberAtAbsolutePositionInternal
protected AbstractMemberMetaData getMetaDataForManagedMemberAtAbsolutePositionInternal(int abs_position)(Code)
Internal method to get the field/property for an absolute field number. If the field for that absolute field position is overridden by a field in this class then this field/property will be returned.
Parameters:
  abs_position - The position of the managed field including thesuperclass. Fields are numbered from 0 in the root superclass. The managed field at this "absolute" position.

getMetaDataForManagedMemberAtPosition
public AbstractMemberMetaData getMetaDataForManagedMemberAtPosition(int position)(Code)
Accessor for MetaData for a managed field/property in this class. The position is relative to the first field in this class (ignores superclasses).
Parameters:
  position - The position of the managed field. 0 = first in the class The JDO managed field at that position

getMetaDataForMember
public AbstractMemberMetaData getMetaDataForMember(String name)(Code)
Accessor for the Meta-Data for a field/property. Include superclasses.
Parameters:
  name - the name of the field/property Meta-Data for the field.

getMetaDataForMemberAtRelativePosition
public AbstractMemberMetaData getMetaDataForMemberAtRelativePosition(int index)(Code)
Accessor for the metadata of a field/property. Does not include superclasses
Parameters:
  index - field index relative to this class only starting from 0 Meta-Data for the field/property

getMetaDataManager
public MetaDataManager getMetaDataManager()(Code)
Convenience accessor for the MetaData Manager in use. MetaDataManager.

getName
public String getName()(Code)
Accessor for the class name. class name

getNoOfInheritedManagedMembers
public int getNoOfInheritedManagedMembers()(Code)
Accessor for the number of inherited managed fields/properties in superclasses. No of inherited managed fields/properties in superclasses.

getNoOfManagedMembers
public int getNoOfManagedMembers()(Code)
Accessor for the number of managed fields/properties (this class only). no of managed fields/properties in this class

getNoOfMembers
public int getNoOfMembers()(Code)
Accessor for the number of fields/properties. This is the total number of fields/properties (inc static, final etc) in this class no of fields/properties.

getNoOfOverriddenMembers
public int getNoOfOverriddenMembers()(Code)
Accessor for the number of overridden fields/properties (this class only). no of overridden fields/properties in this class

getNoOfPrimaryKeyMembers
public int getNoOfPrimaryKeyMembers()(Code)
Accessor for the number of primary key fields/properties. no of primary key fields/properties

getNoOfQueries
public int getNoOfQueries()(Code)
Accessor for the number of named queries. no of named queries

getNonPKMemberFlags
public boolean[] getNonPKMemberFlags()(Code)
Accessor for the flags of the non primary key fields/properties (inc superclass members). The flags whether the field/property is non primary key

getNonPKMemberPositions
public int[] getNonPKMemberPositions()(Code)
Accessor for the positions of the non primary key fields/properties (inc superclass fields). The member positions

getObjectidClass
public String getObjectidClass()(Code)
Accessor for the objectid-class tag value. the fully qualified objectid class name

getOverriddenMember
public AbstractMemberMetaData getOverriddenMember(int position)(Code)
Accessor for MetaData for an overridden field/property in this class.
Parameters:
  position - The position of the overridden field/property. MetaData for the field/property at that position

getOverriddenMember
public AbstractMemberMetaData getOverriddenMember(String name)(Code)
Accessor for an overridden field/property with the specified name.
Parameters:
  name - Name of the field/property The MetaData for the field/property

getOverriddenMembers
public AbstractMemberMetaData[] getOverriddenMembers()(Code)
Accessor for the overridden fields/properties in this class. The overridden fields/properties in this class

getPKMemberPositions
public int[] getPKMemberPositions()(Code)
Accessor for the field numbers of the primary key fields/properties. These are absolute numbers (including superclasses). The positions of the primary key fields/properties.

getPackageMetaData
public PackageMetaData getPackageMetaData()(Code)
Convenience accessor for the parent Package MetaData. MetaData for parent package.

getPackageName
public String getPackageName()(Code)
Convenience accessor for the package name. package name.

getPersistenceCapableMemberPositions
public int[] getPersistenceCapableMemberPositions()(Code)
Accessor for the absolute positions of the PersistenceCapable fields/properties. The positions of the PersistenceCapable fields/properties (inc superclasses).

getPersistenceCapableSuperclass
public String getPersistenceCapableSuperclass()(Code)
Accessor for the persistence-capable-superclass tag value. persistence-capable-superclass tag value

getPersistenceModifier
public ClassPersistenceModifier getPersistenceModifier()(Code)
Accessor for the persistence-modifier of the class. persistence-modifier tag value

getPrimaryKeyMemberNames
public String[] getPrimaryKeyMemberNames()(Code)
Accessor for the names of the primary key fields/properties. Only valid after being populated. Provided as a convenience where we need to get the names of the PK members but cant wait til initialisation. names of the PK fields/properties

getPrimaryKeyMetaData
final public PrimaryKeyMetaData getPrimaryKeyMetaData()(Code)
Accessor for primaryKeyMetaData Returns the primaryKey MetaData.

getQueries
public QueryMetaData[] getQueries()(Code)
Accessor for the metadata of the named queries. Meta-Data for the named queries.

getQueryResultMetaData
public QueryResultMetaData[] getQueryResultMetaData()(Code)
Get the query result MetaData registered for this class. Query Result MetaData defined for this class

getReferencedClassMetaData
void getReferencedClassMetaData(List orderedCMDs, Set referencedCMDs, String dba_vendor_id, ClassLoaderResolver clr)(Code)
Method to return the ClassMetaData records for classes referenced by this object. This adds the entries to orderedCMDs ordered by dependency, and to referencedCMDs for fast lookups.
Uses recursion to add all referenced ClassMetaData for any fields, objectid classes, superclasses, and JPOX extension RDBMS "views".

This is the entry point for this process, and provides the core of the "persistence-by-reachability" concept.

Parameters:
  orderedCMDs - List of ordered ClassMetaData objects (added to).
Parameters:
  referencedCMDs - Set of all ClassMetaData objects (added to).
Parameters:
  dba_vendor_id - Vendor ID of the DBA. Used for view addition.
Parameters:
  clr - the ClassLoaderResolver

getRelationMemberPositions
public int[] getRelationMemberPositions(ClassLoaderResolver clr)(Code)
Convenience method to return the absolute positions of all fields/properties that have relations.
Parameters:
  clr - ClassLoader resolver The absolute positions of all fields/properties that have relations

getRelativePositionOfMember
public int getRelativePositionOfMember(String memberName)(Code)
Accessor for the position of the field/property with the specified name. The returned position is relative to this class only.
Parameters:
  memberName - Name of the field/property Position of the field/property in this class.

getSCOContainerMemberPositions
public int[] getSCOContainerMemberPositions()(Code)
Accessor for the absolute positions of all SCO fields/properties that are containers. Positions of all SCO container fields/properties.

getSCOMutableMemberFlags
public boolean[] getSCOMutableMemberFlags()(Code)
Accessor for the flags of the SCO mutable fields (inc superclass fields). The flags whether the field is second class mutable

getSCOMutableMemberPositions
public int[] getSCOMutableMemberPositions()(Code)
Accessor for the absolute positions of the second class mutable fields/properties. The field numbers of the second class mutable fields (inc superclasses).

getSCONonContainerMemberPositions
public int[] getSCONonContainerMemberPositions()(Code)
Accessor for the absolute positions of all SCO fields/properties that are NOT containers (e.g Dates, Points, etc) Field numbers of all SCO non-container fields/properties

getSchema
public String getSchema()(Code)
Accessor for the schema name. schema name

getSuperAbstractClassMetaData
public AbstractClassMetaData getSuperAbstractClassMetaData()(Code)
Accessor for the Meta-Data for the superclass of this class. MetaData of the superclass

getTable
public String getTable()(Code)
Accessor for the table name. table name

getUniqueMetaData
final public UniqueMetaData[] getUniqueMetaData()(Code)
Accessor for UniqueMetaData Returns the UniqueMetaData.

getUnmappedColumns
final public List getUnmappedColumns()(Code)
Accessor for the unmapped columns require for the datastore table. The list of unmapped columns

getVersionMetaData
final public VersionMetaData getVersionMetaData()(Code)
Accessor for Version MetaData for objects stored in this table Returns the versionMetaData.

getVersionMetaDataForTable
final public VersionMetaData getVersionMetaDataForTable()(Code)
Convenience method to find the version MetaData defining versioning for the same table as this class is using. Traverses up the inheritance tree to find the highest class that uses "subclass-table" that has version metadata defined, and returns the MetaData. Version MetaData for the highest class in this tree using subclass-table

hasMember
public boolean hasMember(String memberName)(Code)
Method to check if a field/property exists in this classes definition.
Parameters:
  memberName - Name of field/property return true if exists.

hasRelations
public boolean hasRelations(ClassLoaderResolver clr)(Code)
Convenience method to return if the class has relations to other objects. Includes superclasses. Whether the class has any relations (that it knows about)

inheritDetachableSettings
protected void inheritDetachableSettings()(Code)
Inherit detach settings from super classes. This class is forced to be detachable if the super classes is.

inheritIdentity
protected void inheritIdentity()(Code)
Inherit the identity definition from super classes.
throws:
  InvalidMetaDataException - if the MetaData of this class conflicts with super classes definition

initialise
abstract public void initialise()(Code)
Method to initialise the sub-objects of this class metadata. If populate() is going to be used it should be used BEFORE calling this method. Subclasses must overwrite this method and invoke this

isDetachable
public boolean isDetachable()(Code)
Accessor for the detachable tag value. detachable tag value

isEmbeddedOnly
public boolean isEmbeddedOnly()(Code)
Accessor for the embedded-only tag value. embedded-only tag value

isExcludeDefaultListeners
public boolean isExcludeDefaultListeners()(Code)
Whether default listeners are not going to be invoked true if default listeners are not invoked

isExcludeSuperClassListeners
public boolean isExcludeSuperClassListeners()(Code)
Whether super classes listeners are not going to be invoked true if super class listeners are not invoked

isImplementationOfPersistentDefinition
public boolean isImplementationOfPersistentDefinition()(Code)
Return whether this MetaData is for an implementation of a persistent definition. This could be an implementation of a persistent interface or a persistent abstract-class. Whether this is an implementation

isMetaDataComplete
public boolean isMetaDataComplete()(Code)
Accessor for whether this class is fully specified by this metadata and that any annotations should be ignored. Whether we should ignore any annotations

isRequiresExtent
public boolean isRequiresExtent()(Code)
Accessor for the requires-extent tag value. requires-extent tag value

isSameOrAncestorOf
public boolean isSameOrAncestorOf(AbstractClassMetaData cmd)(Code)
Check if the argument cmd is the same as this or a descedent.
Parameters:
  cmd - the AbstractClassMetaData to be verify if this is an ancestor true if the argument is a child or same as this

loadClass
protected Class loadClass(ClassLoaderResolver clr, ClassLoader primary)(Code)
Load the persistent interface/class
Parameters:
  clr - the ClassLoader
Parameters:
  primary - the primary ClassLoader to use (or null) the loaded class

newDefaultedProperty
protected AbstractMemberMetaData newDefaultedProperty(String name)(Code)
Utility to add a defaulted PropertyMetaData to the class. Provided as a method since then any derived classes can override it.
Parameters:
  name - name of property the new PropertyMetaData

populate
abstract public void populate(ClassLoaderResolver clr, ClassLoader primary)(Code)
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 specifed that are inconsistent with the class being represented.
This method must be invoked by subclasses during populate operations

Parameters:
  clr - ClassLoaderResolver to use in loading any classes
Parameters:
  primary - the primary ClassLoader to use (or null)

setCatalog
final public void setCatalog(String catalog)(Code)
Mutator for the catalog name.
Parameters:
  catalog - Name of the catalog

setEmbeddedOnly
public void setEmbeddedOnly()(Code)
Convenience method to make this class available for storing only when embedded in another object.

setIdentityMetaData
final public void setIdentityMetaData(IdentityMetaData identityMetaData)(Code)
Mutator for the identity MetaData.
Parameters:
  identityMetaData - The identityMetaData to set.

setIdentityType
public void setIdentityType(IdentityType type)(Code)
Cinvenience method for updating the identity type when not set correctly during construction. This is needed where we have annotations and the user hasnt defined "APPLICATION", and we find a field defined as @PrimaryKey so we set it to APPLICATION at that point.
Parameters:
  type - The Identity type to use

setInheritanceMetaData
final public void setInheritanceMetaData(InheritanceMetaData inheritanceMetaData)(Code)
Mutator for the inheritance MetaData.
Parameters:
  inheritanceMetaData - The inheritanceMetaData to set.

setMetaDataComplete
public void setMetaDataComplete()(Code)
Method to set that this class is "metadata complete" (see JPA spec). Means that any annotations will be ignored.

setObjectIdClass
final public void setObjectIdClass(String objectidClass)(Code)
Mutator for the object id class name.
Parameters:
  objectidClass - Name of the id class

setPrimaryKeyMetaData
final public void setPrimaryKeyMetaData(PrimaryKeyMetaData primaryKeyMetaData)(Code)
Mutator for the PrimaryKey MetaData.
Parameters:
  primaryKeyMetaData - The PrimaryKey MetaData to set.

setSchema
final public void setSchema(String schema)(Code)
Mutator for the schema name.
Parameters:
  schema - Name of the schema

setTable
final public void setTable(String table)(Code)
Mutator for the table name.
Parameters:
  table - Name of the table

setVersionMetaData
final public void setVersionMetaData(VersionMetaData versionMetaData)(Code)
Mutator for the Version MetaData.
Parameters:
  versionMetaData - The versionMetaData to set.

usesSingleFieldIdentityClass
public boolean usesSingleFieldIdentityClass()(Code)
Whether this PersistenceCapable class uses SingleFieldIdentity true if using SingleFieldIdentity as objectid class

validateDeprecatedMetaData
protected void validateDeprecatedMetaData()(Code)
Check usage of deprecated MetaData
throws:
  InvalidMetaDataException - if deprecated MetaData is used

validateUnmappedColumns
protected void validateUnmappedColumns()(Code)
Convenience method to validate the specified "unmapped" columns.
throws:
  InvalidMetaDataException - if a column is specified without its name.

validateUserInputForIdentity
protected void validateUserInputForIdentity()(Code)
Check for conflicts on super class and this class MetaData identity
throws:
  InvalidMetaDataException - if the user tries to overwrite a super class identity / strategy

validateUserInputForInheritanceMetaData
protected void validateUserInputForInheritanceMetaData()(Code)
Check if the inheritance MetaData is credible.
throws:
  InvalidMetaDataException - if the strategy is superclass-table, yet there are no super class
throws:
  InvalidMetaDataException - if the strategy is superclass-table, yet the super class has notspecified a discriminator
throws:
  InvalidMetaDataException - if the strategy is superclass-table and discriminator is "value-map",yet no value for the discriminator has been specified

Fields inherited from org.jpox.metadata.MetaData
final public static String JPOX_VENDOR_NAME(Code)(Java Doc)
protected static Localiser LOCALISER(Code)(Java Doc)
final public static int METADATA_CREATED_STATE(Code)(Java Doc)
final public static int METADATA_INITIALISED_STATE(Code)(Java Doc)
final public static int METADATA_POPULATED_STATE(Code)(Java Doc)
final public static int METADATA_USED_STATE(Code)(Java Doc)
protected Collection extensions(Code)(Java Doc)
protected int metaDataState(Code)(Java Doc)
protected MetaData parent(Code)(Java Doc)

Methods inherited from org.jpox.metadata.MetaData
public void addExtension(String vendor, String key, String value)(Code)(Java Doc)
public void addExtension(String key, String value)(Code)(Java Doc)
public ExtensionMetaData[] getExtensions()(Code)(Java Doc)
public int getNoOfExtensions()(Code)(Java Doc)
public MetaData getParent()(Code)(Java Doc)
public String getValueForExtension(String key)(Code)(Java Doc)
public String[] getValuesForExtension(String key)(Code)(Java Doc)
public boolean hasExtension(String key)(Code)(Java Doc)
public void initialise()(Code)(Java Doc)
public boolean isInitialised()(Code)(Java Doc)
public boolean isPopulated()(Code)(Java Doc)
public boolean isUsed()(Code)(Java Doc)
public void populate()(Code)(Java Doc)
public void removeExtension(String key)(Code)(Java Doc)
public void setInitialised()(Code)(Java Doc)
public void setParent(MetaData md)(Code)(Java Doc)
public void setPopulated()(Code)(Java Doc)
public void setUsed()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
public String toString(String prefix, String indent)(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.