Top Description Fields Constructors Methods
org.eclipse.persistence.internal.jpa.metadata.sequencing

public Class TableGeneratorMetadata

extends TableMetadata
Class Inheritance
Imports
org.eclipse.persistence.internal.jpa.metadata.MetadataLogger, .MetadataProject, org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAnnotation, org.eclipse.persistence.internal.jpa.metadata.tables.TableMetadata, org.eclipse.persistence.sequencing.TableSequence
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.
Author
Guy Pelletier
Since
EclipseLink 1.0

Field Summary

Modifier and TypeField and Description
private Integer
m_allocationSize

private String
m_generatorName

private Integer
m_initialValue

private String
m_pkColumnName

private String
m_pkColumnValue

private String
m_valueColumnName

Constructor Summary

AccessConstructor and Description
public
TableGeneratorMetadata()

INTERNAL: Used for XML loading.

public
TableGeneratorMetadata(MetadataAnnotation tableGenerator, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

public
TableGeneratorMetadata(String pkColumnValue)

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

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
objectToCompare)

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

INTERNAL:
public Integer
getAllocationSize()

INTERNAL: Used for OX mapping.

public String
getCatalogContext()

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

INTERNAL:
public String
getGeneratorName()

INTERNAL: Used for OX mapping.

public String
getIdentifier()

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

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

INTERNAL: Used for OX mapping.

public String
getNameContext()

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

INTERNAL:
public String
getPkColumnName()

INTERNAL: Used for OX mapping.

public String
getPkColumnValue()

INTERNAL: Used for OX mapping.

public String
getSchemaContext()

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

INTERNAL:
public String
getValueColumnName()

INTERNAL: Used for OX mapping.

public int
hashCode()

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

Returns a hash code value for the object.
public TableSequence
process(MetadataLogger logger)

INTERNAL:

public void
setAllocationSize(Integer allocationSize)

INTERNAL: Used for OX mapping.

public void
setGeneratorName(String generatorName)

INTERNAL: Used for OX mapping.

public void
setInitialValue(Integer initialValue)

INTERNAL: Used for OX mapping.

public void
setPkColumnName(String pkColumnName)

INTERNAL: Used for OX mapping.

public void
setPkColumnValue(String pkColumnValue)

INTERNAL: Used for OX mapping.

public void
setValueColumnName(String valueColumnName)

INTERNAL: Used for OX mapping.

public String
toString()

Overrides java.lang.Object.toString.

INTERNAL:
Inherited from org.eclipse.persistence.internal.jpa.metadata.tables.TableMetadata:
getCataloggetCreationSuffixgetDatabaseTablegetIndexesgetNamegetSchemagetUniqueConstraintsinitXMLObjectprocessCreationSuffixprocessForeignKeyprocessIndexesprocessUniqueConstraintssetCatalogsetCreationSuffixsetDatabaseTablesetFullyQualifiedTableNamesetIndexessetNamesetSchemasetUniqueConstraintssetUseDelimiters

Field Detail

m_allocationSizeback to summary
private Integer m_allocationSize
m_generatorNameback to summary
private String m_generatorName
m_initialValueback to summary
private Integer m_initialValue
m_pkColumnNameback to summary
private String m_pkColumnName
m_pkColumnValueback to summary
private String m_pkColumnValue
m_valueColumnNameback to summary
private String m_valueColumnName

Constructor Detail

TableGeneratorMetadataback to summary
public TableGeneratorMetadata()

INTERNAL: Used for XML loading.

TableGeneratorMetadataback to summary
public TableGeneratorMetadata(MetadataAnnotation tableGenerator, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

TableGeneratorMetadataback to summary
public TableGeneratorMetadata(String pkColumnValue)

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

See Also
processSequencingAccesssors.

Method Detail

equalsback to summary
public boolean equals(Object objectToCompare)

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

INTERNAL:

Parameters
objectToCompare:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getAllocationSizeback to summary
public Integer getAllocationSize()

INTERNAL: Used for OX mapping.

getCatalogContextback to summary
public String getCatalogContext()

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

INTERNAL:

Annotations
@Override
getGeneratorNameback to summary
public String getGeneratorName()

INTERNAL: Used for OX mapping.

getIdentifierback to summary
public String getIdentifier()

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

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

Annotations
@Override
getInitialValueback to summary
public Integer getInitialValue()

INTERNAL: Used for OX mapping.

getNameContextback to summary
public String getNameContext()

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

INTERNAL:

Annotations
@Override
getPkColumnNameback to summary
public String getPkColumnName()

INTERNAL: Used for OX mapping.

getPkColumnValueback to summary
public String getPkColumnValue()

INTERNAL: Used for OX mapping.

getSchemaContextback to summary
public String getSchemaContext()

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

INTERNAL:

Annotations
@Override
getValueColumnNameback to summary
public String getValueColumnName()

INTERNAL: Used for OX mapping.

hashCodeback to summary
public int hashCode()

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

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
processback to summary
public TableSequence process(MetadataLogger logger)

INTERNAL:

setAllocationSizeback to summary
public void setAllocationSize(Integer allocationSize)

INTERNAL: Used for OX mapping.

setGeneratorNameback to summary
public void setGeneratorName(String generatorName)

INTERNAL: Used for OX mapping.

setInitialValueback to summary
public void setInitialValue(Integer initialValue)

INTERNAL: Used for OX mapping.

setPkColumnNameback to summary
public void setPkColumnName(String pkColumnName)

INTERNAL: Used for OX mapping.

setPkColumnValueback to summary
public void setPkColumnValue(String pkColumnValue)

INTERNAL: Used for OX mapping.

setValueColumnNameback to summary
public void setValueColumnName(String valueColumnName)

INTERNAL: Used for OX mapping.

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

INTERNAL:

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object.

Annotations
@Override