org.eclipse.persistence.internal.jpa.metadata.sequencing

Class TableGeneratorMetadata

java.lang.Object

org.eclipse.persistence.internal.jpa.metadata.ORMetadata

org.eclipse.persistence.internal.jpa.metadata.tables.TableMetadata

org.eclipse.persistence.internal.jpa.metadata.sequencing.TableGeneratorMetadata

public class TableGeneratorMetadata
extends TableMetadata

A wrapper class to a table generator metadata. Key notes: - any metadata mapped from XML to this class must be compared in the equals method. - when loading from annotations, the constructor accepts the metadata accessor this metadata was loaded from. Used it to look up any 'companion' annotation needed for processing. - methods should be preserved in alphabetical order.

Since:

EclipseLink 1.0

Author:

Guy Pelletier

Constructor Summary

Constructors

Constructor and Description
TableGeneratorMetadata() INTERNAL: Used for XML loading.
TableGeneratorMetadata(MetadataAnnotation tableGenerator, MetadataAccessor accessor) INTERNAL: Used for annotation loading.
TableGeneratorMetadata(String pkColumnValue) INTERNAL This constructor is used to create a default table generator.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) INTERNAL:
Integer	getAllocationSize() INTERNAL: Used for OX mapping.
String	getCatalogContext() INTERNAL:
String	getGeneratorName() INTERNAL: Used for OX mapping.
String	getIdentifier() INTERNAL: To satisfy the abstract getIdentifier() method from ORMetadata.
Integer	getInitialValue() INTERNAL: Used for OX mapping.
String	getNameContext() INTERNAL:
String	getPkColumnName() INTERNAL: Used for OX mapping.
String	getPkColumnValue() INTERNAL: Used for OX mapping.
String	getSchemaContext() INTERNAL:
String	getValueColumnName() INTERNAL: Used for OX mapping.
TableSequence	process(MetadataLogger logger) INTERNAL:
void	setAllocationSize(Integer allocationSize) INTERNAL: Used for OX mapping.
void	setGeneratorName(String generatorName) INTERNAL: Used for OX mapping.
void	setInitialValue(Integer initialValue) INTERNAL: Used for OX mapping.
void	setPkColumnName(String pkColumnName) INTERNAL: Used for OX mapping.
void	setPkColumnValue(String pkColumnValue) INTERNAL: Used for OX mapping.
void	setValueColumnName(String valueColumnName) INTERNAL: Used for OX mapping.
String	toString() INTERNAL:

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.tables.TableMetadata

getCatalog, getCreationSuffix, getDatabaseTable, getIndexes, getName, getSchema, getUniqueConstraints, initXMLObject, processCreationSuffix, processForeignKey, processIndexes, processUniqueConstraints, setCatalog, setCreationSuffix, setDatabaseTable, setFullyQualifiedTableName, setIndexes, setName, setSchema, setUniqueConstraints, setUseDelimiters

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.ORMetadata

getAccessibleObjectName, getAnnotation, getEntityMappings, getJavaClassName, getLoader, getLocation, getLogger, getMetadataClass, getMetadataClass, getMetadataClass, getMetadataFactory, getProject, loadedFromAnnotation, loadedFromEclipseLinkXML, loadedFromXML, setAccessibleObject, setEntityMappings, setProject, shouldOverride

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TableGeneratorMetadata

public TableGeneratorMetadata()

INTERNAL: Used for XML loading.

TableGeneratorMetadata

public TableGeneratorMetadata(MetadataAnnotation tableGenerator,
                              MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

TableGeneratorMetadata

public TableGeneratorMetadata(String pkColumnValue)

INTERNAL This constructor is used to create a default table generator.

See Also:

processSequencingAccesssors.

Method Detail

equals

public boolean equals(Object objectToCompare)

INTERNAL:

Overrides:

equals in class TableMetadata

getAllocationSize

public Integer getAllocationSize()

INTERNAL: Used for OX mapping.

getCatalogContext

public String getCatalogContext()

INTERNAL:

Overrides:

getCatalogContext in class TableMetadata

getGeneratorName

public String getGeneratorName()

INTERNAL: Used for OX mapping.

getIdentifier

public String getIdentifier()

INTERNAL: To satisfy the abstract getIdentifier() method from ORMetadata.

See Also:

shouldOverride, mergeListsAndOverride

getInitialValue

public Integer getInitialValue()

INTERNAL: Used for OX mapping.

getNameContext

public String getNameContext()

INTERNAL:

Overrides:

getNameContext in class TableMetadata

getPkColumnName

public String getPkColumnName()

INTERNAL: Used for OX mapping.

getPkColumnValue

public String getPkColumnValue()

INTERNAL: Used for OX mapping.

getSchemaContext

public String getSchemaContext()

INTERNAL:

Overrides:

getSchemaContext in class TableMetadata

getValueColumnName

public String getValueColumnName()

INTERNAL: Used for OX mapping.

process

public TableSequence process(MetadataLogger logger)

INTERNAL:

setAllocationSize

public void setAllocationSize(Integer allocationSize)

INTERNAL: Used for OX mapping.

setGeneratorName

public void setGeneratorName(String generatorName)

INTERNAL: Used for OX mapping.

setInitialValue

public void setInitialValue(Integer initialValue)

INTERNAL: Used for OX mapping.

setPkColumnName

public void setPkColumnName(String pkColumnName)

INTERNAL: Used for OX mapping.

setPkColumnValue

public void setPkColumnValue(String pkColumnValue)

INTERNAL: Used for OX mapping.

setValueColumnName

public void setValueColumnName(String valueColumnName)

INTERNAL: Used for OX mapping.

toString

public String toString()

INTERNAL:

Overrides:

toString in class Object