javax.jdo.metadata
Interface ComponentMetadata

All Superinterfaces:
Metadata
All Known Subinterfaces:
ClassMetadata, InterfaceMetadata

public interface ComponentMetadata
extends Metadata

Represents a class or interface. Extended for the specifics of those cases.

Since:
2.3

Method Summary
 boolean getCacheable()
          Accessor for whether this is cacheable.
 java.lang.String getCatalog()
          Accessor for the catalog (ORM) for this component
 ColumnMetadata[] getColumns()
          Accessor for all column(s) defined on the join.
 DatastoreIdentityMetadata getDatastoreIdentityMetadata()
          Accessor for the datastore identity details.
 boolean getDetachable()
          Accessor for whether this is detachable.
 java.lang.Boolean getEmbeddedOnly()
          Accessor for whether this is embedded only.
 FetchGroupMetadata[] getFetchGroups()
          Accessor for all FetchGroup defined on the component.
 ForeignKeyMetadata[] getForeignKeys()
          Accessor for all fk(s) defined on the component.
 IdentityType getIdentityType()
          Accessor for the identity type to use.
 IndexMetadata[] getIndices()
          Accessor for all index(s) defined on the component.
 InheritanceMetadata getInheritanceMetadata()
          Accessor for the inheritance (if any).
 JoinMetadata[] getJoins()
          Accessor for all joins(s) defined on the component.
 MemberMetadata[] getMembers()
          Accessor for all fields/properties defined on the component.
 java.lang.String getName()
          Accessor for the name of this component (set on construction).
 int getNumberOfColumns()
          Accessor for the number of columns defined for this join.
 int getNumberOfFetchGroups()
          Accessor for the number of fetchGroups defined for this component.
 int getNumberOfForeignKeys()
          Accessor for the number of FKs defined for this component.
 int getNumberOfIndices()
          Accessor for the number of indices defined for this component.
 int getNumberOfJoins()
          Accessor for the number of join(s) defined for this component.
 int getNumberOfMembers()
          Accessor for the number of fields/properties defined for this component.
 int getNumberOfQueries()
          Accessor for the number of named queries defined for this component.
 int getNumberOfUniques()
          Accessor for the number of unique constraints defined for this component.
 java.lang.String getObjectIdClass()
          Accessor for the object-id class (if defined).
 PrimaryKeyMetadata getPrimaryKeyMetadata()
          Accessor for the primary key (if any).
 QueryMetadata[] getQueries()
          Accessor for all named queries defined on the component.
 boolean getRequiresExtent()
          Accessor for whether the component requires an extent.
 java.lang.String getSchema()
          Accessor for the schema (ORM) for this component
 boolean getSerializeRead()
          Accessor for the value of serializeRead for objects of this type.
 java.lang.String getTable()
          Accessor for the name of the table.
 UniqueMetadata[] getUniques()
          Accessor for all unique constraints defined on the component.
 VersionMetadata getVersionMetadata()
          Accessor for the version (if any).
 ColumnMetadata newColumnMetadata()
          Add a new column for this join.
 DatastoreIdentityMetadata newDatastoreIdentityMetadata()
          Method to define the datastore identity metadata details.
 FetchGroupMetadata newFetchGroupMetadata(java.lang.String name)
          Add a new FetchGroup for this component.
 ForeignKeyMetadata newForeignKeyMetadata()
          Add a new FK for this component.
 IndexMetadata newIndexMetadata()
          Add a new index for this component.
 InheritanceMetadata newInheritanceMetadata()
          Method to define the inheritance metadata.
 JoinMetadata newJoinMetadata()
          Add a join for this component.
 PrimaryKeyMetadata newPrimaryKeyMetadata()
          Method to define the primary key details.
 PropertyMetadata newPropertyMetadata(java.lang.reflect.Method method)
          Add a new property for this component.
 PropertyMetadata newPropertyMetadata(java.lang.String name)
          Add a new property for this component.
 QueryMetadata newQueryMetadata(java.lang.String name)
          Add a new query for this component.
 UniqueMetadata newUniqueMetadata()
          Add a new unique constraint for this component.
 VersionMetadata newVersionMetadata()
          Method to define the version metadata.
 ComponentMetadata setCacheable(boolean cacheable)
          Method to set whether this is cacheable
 ComponentMetadata setCatalog(java.lang.String catalog)
          Method to set the catalog (ORM) for this component
 ComponentMetadata setDetachable(boolean detachable)
          Method to set whether this is detachable
 ComponentMetadata setEmbeddedOnly(boolean extent)
          Method to set whether it is stored only as embedded in other objects.
 ComponentMetadata setIdentityType(IdentityType id)
          Method to define the identity type to use.
 ComponentMetadata setObjectIdClass(java.lang.String idclass)
          Method to set the object-id (PK) class.
 ComponentMetadata setRequiresExtent(boolean extent)
          Method to set whether the component requires an extent.
 ComponentMetadata setSchema(java.lang.String schema)
          Method to set the schema (ORM) for this component
 ComponentMetadata setSerializeRead(boolean flag)
          Method to set the default value of serializeRead for objects of this type.
 ComponentMetadata setTable(java.lang.String table)
          Method to set the table name.
 
Methods inherited from interface javax.jdo.metadata.Metadata
getExtensions, getNumberOfExtensions, getParent, newExtensionMetaData
 

Method Detail

getName

java.lang.String getName()
Accessor for the name of this component (set on construction).

Returns:
The name

setIdentityType

ComponentMetadata setIdentityType(IdentityType id)
Method to define the identity type to use.

Parameters:
id - identity type

getIdentityType

IdentityType getIdentityType()
Accessor for the identity type to use.

Returns:
identity type

setObjectIdClass

ComponentMetadata setObjectIdClass(java.lang.String idclass)
Method to set the object-id (PK) class.

Parameters:
idclass - Object-id class

getObjectIdClass

java.lang.String getObjectIdClass()
Accessor for the object-id class (if defined).

Returns:
The object-id class

setRequiresExtent

ComponentMetadata setRequiresExtent(boolean extent)
Method to set whether the component requires an extent.

Parameters:
extent - Requires extent?

getRequiresExtent

boolean getRequiresExtent()
Accessor for whether the component requires an extent.

Returns:
Requires extent?

setDetachable

ComponentMetadata setDetachable(boolean detachable)
Method to set whether this is detachable

Parameters:
detachable - Detachable?

getDetachable

boolean getDetachable()
Accessor for whether this is detachable.

Returns:
Detachable?

setCacheable

ComponentMetadata setCacheable(boolean cacheable)
Method to set whether this is cacheable

Parameters:
cacheable - Cacheable?

getCacheable

boolean getCacheable()
Accessor for whether this is cacheable.

Returns:
Detachable?

setSerializeRead

ComponentMetadata setSerializeRead(boolean flag)
Method to set the default value of serializeRead for objects of this type.

Parameters:
flag - serializeRead

getSerializeRead

boolean getSerializeRead()
Accessor for the value of serializeRead for objects of this type.

Returns:
SerializeRead?

setEmbeddedOnly

ComponentMetadata setEmbeddedOnly(boolean extent)
Method to set whether it is stored only as embedded in other objects.

Parameters:
embedded - Whether it is only stored embedded

getEmbeddedOnly

java.lang.Boolean getEmbeddedOnly()
Accessor for whether this is embedded only.

Returns:
Only stored as embedded

setCatalog

ComponentMetadata setCatalog(java.lang.String catalog)
Method to set the catalog (ORM) for this component

Parameters:
catalog - Catalog name

getCatalog

java.lang.String getCatalog()
Accessor for the catalog (ORM) for this component

Returns:
The catalog

setSchema

ComponentMetadata setSchema(java.lang.String schema)
Method to set the schema (ORM) for this component

Parameters:
schema - Schema name

getSchema

java.lang.String getSchema()
Accessor for the schema (ORM) for this component

Returns:
The schema

setTable

ComponentMetadata setTable(java.lang.String table)
Method to set the table name.

Parameters:
table - Table name

getTable

java.lang.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

PropertyMetadata newPropertyMetadata(java.lang.String name)
Add a new property for this component.

Parameters:
name - Name of the property
Returns:
The PropertyMetadata

newPropertyMetadata

PropertyMetadata newPropertyMetadata(java.lang.reflect.Method method)
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

QueryMetadata newQueryMetadata(java.lang.String name)
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

FetchGroupMetadata newFetchGroupMetadata(java.lang.String name)
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


Copyright © 2005-2009 Apache Software Foundation. All Rights Reserved.