Package javax.jdo.metadata
Interface TypeMetadata
- All Superinterfaces:
Metadata
- All Known Subinterfaces:
ClassMetadata
,InterfaceMetadata
Represents a class or interface. Extended for the specifics of those cases.
- Since:
- 3.0
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Accessor for whether this is cacheable.Accessor for the catalog (ORM) for this component.Accessor for all column(s) defined on the join.Accessor for the datastore identity details.boolean
Accessor for whether this is detachable.Accessor for whether this is embedded only.Accessor for all FetchGroup defined on the component.Accessor for all fk(s) defined on the component.Accessor for the identity type to use.Accessor for all index(s) defined on the component.Accessor for the inheritance (if any).getJoins()
Accessor for all joins(s) defined on the component.Accessor for all fields/properties defined on the component.getName()
Accessor for the name of this component (set on construction).int
Accessor for the number of columns defined for this join.int
Accessor for the number of fetchGroups defined for this component.int
Accessor for the number of FKs defined for this component.int
Accessor for the number of indices defined for this component.int
Accessor for the number of join(s) defined for this component.int
Accessor for the number of fields/properties defined for this component.int
Accessor for the number of named queries defined for this component.int
Accessor for the number of unique constraints defined for this component.Accessor for the object-id class (if defined).Accessor for the primary key (if any).Accessor for all named queries defined on the component.boolean
Accessor for whether the component requires an extent.Accessor for the schema (ORM) for this component.boolean
Accessor for the value of serializeRead for objects of this type.getTable()
Accessor for the name of the table.Accessor for all unique constraints defined on the component.Accessor for the version (if any).Add a new column for this join.Method to define the datastore identity metadata details.newFetchGroupMetadata
(String name) Add a new FetchGroup for this component.Add a new FK for this component.Add a new index for this component.Method to define the inheritance metadata.Add a join for this component.Method to define the primary key details.newPropertyMetadata
(Method method) Add a new property for this component.newPropertyMetadata
(String name) Add a new property for this component.newQueryMetadata
(String name) Add a new query for this component.Add a new unique constraint for this component.Method to define the version metadata.setCacheable
(boolean cacheable) Method to set whether this is cacheable.setCatalog
(String catalog) Method to set the catalog (ORM) for this component.setDetachable
(boolean detachable) Method to set whether this is detachable.setEmbeddedOnly
(boolean embedded) Method to set whether it is stored only as embedded in other objects.Method to define the identity type to use.setObjectIdClass
(String idclass) Method to set the object-id (PK) class.setRequiresExtent
(boolean extent) Method to set whether the component requires an extent.Method to set the schema (ORM) for this component.setSerializeRead
(boolean flag) Method to set the default value of serializeRead for objects of this type.Method to set the table name.Methods inherited from interface javax.jdo.metadata.Metadata
getExtensions, getNumberOfExtensions, getParent, newExtensionMetadata
-
Method Details
-
getName
String getName()Accessor for the name of this component (set on construction).- Returns:
- The name
-
setIdentityType
Method to define the identity type to use.- Parameters:
id
- identity type- Returns:
- This metadata object
-
getIdentityType
IdentityType getIdentityType()Accessor for the identity type to use.- Returns:
- identity type
-
setObjectIdClass
Method to set the object-id (PK) class.- Parameters:
idclass
- Object-id class- Returns:
- This metadata object
-
getObjectIdClass
String getObjectIdClass()Accessor for the object-id class (if defined).- Returns:
- The object-id class
-
setRequiresExtent
Method to set whether the component requires an extent.- Parameters:
extent
- Requires extent?- Returns:
- This metadata object
-
getRequiresExtent
boolean getRequiresExtent()Accessor for whether the component requires an extent.- Returns:
- Requires extent?
-
setDetachable
Method to set whether this is detachable.- Parameters:
detachable
- Detachable?- Returns:
- This metadata object
-
getDetachable
boolean getDetachable()Accessor for whether this is detachable.- Returns:
- Detachable?
-
setCacheable
Method to set whether this is cacheable.- Parameters:
cacheable
- Cacheable?- Returns:
- This metadata object
-
getCacheable
boolean getCacheable()Accessor for whether this is cacheable.- Returns:
- Detachable?
-
setSerializeRead
Method to set the default value of serializeRead for objects of this type.- Parameters:
flag
- serializeRead- Returns:
- This metadata object
-
getSerializeRead
boolean getSerializeRead()Accessor for the value of serializeRead for objects of this type.- Returns:
- SerializeRead?
-
setEmbeddedOnly
Method to set whether it is stored only as embedded in other objects.- Parameters:
embedded
- Whether it is only stored embedded- Returns:
- This metadata object
-
getEmbeddedOnly
Boolean getEmbeddedOnly()Accessor for whether this is embedded only.- Returns:
- Only stored as embedded
-
setCatalog
Method to set the catalog (ORM) for this component.- Parameters:
catalog
- Catalog name- Returns:
- This metadata object
-
getCatalog
String getCatalog()Accessor for the catalog (ORM) for this component.- Returns:
- The catalog
-
setSchema
Method to set the schema (ORM) for this component.- Parameters:
schema
- Schema name- Returns:
- This metadata object
-
getSchema
String getSchema()Accessor for the schema (ORM) for this component.- Returns:
- The schema
-
setTable
Method to set the table name.- Parameters:
table
- Table name- Returns:
- This metadata object
-
getTable
String getTable()Accessor for the name of the table.- Returns:
- The name
-
newInheritanceMetadata
InheritanceMetadata newInheritanceMetadata()Method to define the inheritance metadata.- Returns:
- The InheritanceMetadata
-
getInheritanceMetadata
InheritanceMetadata getInheritanceMetadata()Accessor for the inheritance (if any).- Returns:
- inheritance
-
newVersionMetadata
VersionMetadata newVersionMetadata()Method to define the version metadata.- Returns:
- The VersionMetadata
-
getVersionMetadata
VersionMetadata getVersionMetadata()Accessor for the version (if any).- Returns:
- version
-
newDatastoreIdentityMetadata
DatastoreIdentityMetadata newDatastoreIdentityMetadata()Method to define the datastore identity metadata details.- Returns:
- The DatastoreIdentityMetadata
-
getDatastoreIdentityMetadata
DatastoreIdentityMetadata getDatastoreIdentityMetadata()Accessor for the datastore identity details.- Returns:
- datastore identity details
-
newPrimaryKeyMetadata
PrimaryKeyMetadata newPrimaryKeyMetadata()Method to define the primary key details.- Returns:
- The PrimaryKeyMetadata
-
getPrimaryKeyMetadata
PrimaryKeyMetadata getPrimaryKeyMetadata()Accessor for the primary key (if any).- Returns:
- primary key details
-
getJoins
JoinMetadata[] getJoins()Accessor for all joins(s) defined on the component.- Returns:
- The join(s)
-
newJoinMetadata
JoinMetadata newJoinMetadata()Add a join for this component.- Returns:
- The JoinMetadata
-
getNumberOfJoins
int getNumberOfJoins()Accessor for the number of join(s) defined for this component.- Returns:
- The number of join(s)
-
getForeignKeys
ForeignKeyMetadata[] getForeignKeys()Accessor for all fk(s) defined on the component.- Returns:
- The fk(s)
-
newForeignKeyMetadata
ForeignKeyMetadata newForeignKeyMetadata()Add a new FK for this component.- Returns:
- The ForeignKeyMetadata
-
getNumberOfForeignKeys
int getNumberOfForeignKeys()Accessor for the number of FKs defined for this component.- Returns:
- The number of FKs
-
getIndices
IndexMetadata[] getIndices()Accessor for all index(s) defined on the component.- Returns:
- The index(s)
-
newIndexMetadata
IndexMetadata newIndexMetadata()Add a new index for this component.- Returns:
- The IndexMetadata
-
getNumberOfIndices
int getNumberOfIndices()Accessor for the number of indices defined for this component.- Returns:
- The number of indices
-
getUniques
UniqueMetadata[] getUniques()Accessor for all unique constraints defined on the component.- Returns:
- The unique constraints
-
newUniqueMetadata
UniqueMetadata newUniqueMetadata()Add a new unique constraint for this component.- Returns:
- The UniqueMetadata
-
getNumberOfUniques
int getNumberOfUniques()Accessor for the number of unique constraints defined for this component.- Returns:
- The number of unique constraints
-
getMembers
MemberMetadata[] getMembers()Accessor for all fields/properties defined on the component.- Returns:
- The members
-
getNumberOfMembers
int getNumberOfMembers()Accessor for the number of fields/properties defined for this component.- Returns:
- The number of members
-
newPropertyMetadata
Add a new property for this component.- Parameters:
name
- Name of the property- Returns:
- The PropertyMetadata
-
newPropertyMetadata
Add a new property for this component.- Parameters:
method
- Java bean getter/setter method- Returns:
- The PropertyMetadata
-
getQueries
QueryMetadata[] getQueries()Accessor for all named queries defined on the component.- Returns:
- The queries
-
newQueryMetadata
Add a new query for this component.- Parameters:
name
- Name of the query to add- Returns:
- The QueryMetadata
-
getNumberOfQueries
int getNumberOfQueries()Accessor for the number of named queries defined for this component.- Returns:
- The number of named queries
-
getFetchGroups
FetchGroupMetadata[] getFetchGroups()Accessor for all FetchGroup defined on the component.- Returns:
- The FetchGroups
-
newFetchGroupMetadata
Add a new FetchGroup for this component.- Parameters:
name
- Name of the FetchGroup- Returns:
- The FetchGroupMetadata
-
getNumberOfFetchGroups
int getNumberOfFetchGroups()Accessor for the number of fetchGroups defined for this component.- Returns:
- The number of fetch groups
-
getColumns
ColumnMetadata[] getColumns()Accessor for all column(s) defined on the join.- Returns:
- The column(s)
-
newColumnMetadata
ColumnMetadata newColumnMetadata()Add a new column for this join.- Returns:
- The ColumnMetadata
-
getNumberOfColumns
int getNumberOfColumns()Accessor for the number of columns defined for this join.- Returns:
- The number of columns
-