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

public Class SequenceGeneratorMetadata

extends ORMetadata
Class Inheritance
Imports
org.eclipse.persistence.internal.jpa.metadata.MetadataLogger, .MetadataProject, .ORMetadata, org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAnnotation, org.eclipse.persistence.sequencing.NativeSequence
A wrapper class to the MetadataSequenceGenerator that holds onto a @SequenceGenerator for its metadata values. 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
TopLink EJB 3.0 Reference Implementation

Field Summary

Modifier and TypeField and Description
private Integer
m_allocationSize

private String
m_catalog

private Integer
m_initialValue

private String
m_name

private String
m_schema

private String
m_sequenceName

private boolean
m_useIdentityIfPlatformSupports

Inherited from org.eclipse.persistence.internal.jpa.metadata.ORMetadata:
m_project

Constructor Summary

AccessConstructor and Description
public
SequenceGeneratorMetadata()

INTERNAL: Used for XML loading.

public
SequenceGeneratorMetadata(MetadataAnnotation sequenceGenerator, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

public
SequenceGeneratorMetadata(String sequenceName, Integer allocationSize, String catalog, String schema, boolean useIdentityIfPlatformSupports)

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

public
SequenceGeneratorMetadata(String sequenceName, String catalog, String schema)

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

Method Summary

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

Implements abstract org.eclipse.persistence.internal.jpa.metadata.ORMetadata.equals.

INTERNAL:
public Integer
getAllocationSize()

INTERNAL: Used for OX mapping.

public String
getCatalog()

INTERNAL: Used for OX mapping.

public String
getCatalogContext()

INTERNAL:

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
getName()

INTERNAL: Used for OX mapping.

public String
getSchema()

INTERNAL: Used for OX mapping.

public String
getSchemaContext()

INTERNAL:

public String
getSequenceName()

INTERNAL: Used for OX mapping.

public int
hashCode()

Overrides java.lang.Object.hashCode.

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

INTERNAL:

public String
processQualifier()

INTERNAL: Used for processing.

public void
setAllocationSize(Integer allocationSize)

INTERNAL: Used for OX mapping.

public void
setCatalog(String catalog)

INTERNAL: Used for OX mapping.

public void
setInitialValue(Integer initialValue)

INTERNAL: Used for OX mapping.

public void
setName(String name)

INTERNAL: Used for OX mapping.

public void
setSchema(String schema)

INTERNAL: Used for OX mapping.

public void
setSequenceName(String sequenceName)

INTERNAL: Used for OX mapping.

public String
toString()

Overrides java.lang.Object.toString.

INTERNAL:
Inherited from org.eclipse.persistence.internal.jpa.metadata.ORMetadata:
getAccessibleObjectgetAccessibleObjectNamegetAnnotationgetBoxedTypegetDatabaseTypeEnumgetEntityMappingsgetFullyQualifiedClassNamegetJavaClassgetJavaClassNamegetLoadergetLocationgetLoggergetMetadataClassgetMetadataClassgetMetadataClassgetMetadataFactorygetNamegetPrimitiveClassForNamegetProjectgetTextgetXMLElementhasIdentifierhasTextinitXMLClassNameinitXMLObjectinitXMLObjectinitXMLObjectsinitXMLTextObjectloadedFromAnnotationloadedFromEclipseLinkXMLloadedFromXMLmergemergeORObjectListsmergeORObjectsmergeSimpleObjectsreloadEntityreloadMappedSuperclasssetAccessibleObjectsetEntityMappingssetFieldNamesetFieldNamesetProjectshouldOverridevaluesMatchvaluesMatch

Field Detail

m_allocationSizeback to summary
private Integer m_allocationSize
m_catalogback to summary
private String m_catalog
m_initialValueback to summary
private Integer m_initialValue
m_nameback to summary
private String m_name
m_schemaback to summary
private String m_schema
m_sequenceNameback to summary
private String m_sequenceName
m_useIdentityIfPlatformSupportsback to summary
private boolean m_useIdentityIfPlatformSupports

Constructor Detail

SequenceGeneratorMetadataback to summary
public SequenceGeneratorMetadata()

INTERNAL: Used for XML loading.

SequenceGeneratorMetadataback to summary
public SequenceGeneratorMetadata(MetadataAnnotation sequenceGenerator, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

SequenceGeneratorMetadataback to summary
public SequenceGeneratorMetadata(String sequenceName, Integer allocationSize, String catalog, String schema, boolean useIdentityIfPlatformSupports)

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

See Also
processSequencingAccesssors.
SequenceGeneratorMetadataback to summary
public SequenceGeneratorMetadata(String sequenceName, String catalog, String schema)

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

See Also
processSequencingAccesssors.

Method Detail

equalsback to summary
public boolean equals(Object objectToCompare)

Implements abstract org.eclipse.persistence.internal.jpa.metadata.ORMetadata.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.

getCatalogback to summary
public String getCatalog()

INTERNAL: Used for OX mapping.

getCatalogContextback to summary
public String getCatalogContext()

INTERNAL:

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.

getNameback to summary
public String getName()

INTERNAL: Used for OX mapping.

getSchemaback to summary
public String getSchema()

INTERNAL: Used for OX mapping.

getSchemaContextback to summary
public String getSchemaContext()

INTERNAL:

getSequenceNameback to summary
public String getSequenceName()

INTERNAL: Used for OX mapping.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.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 NativeSequence process(MetadataLogger logger)

INTERNAL:

processQualifierback to summary
public String processQualifier()

INTERNAL: Used for processing.

setAllocationSizeback to summary
public void setAllocationSize(Integer allocationSize)

INTERNAL: Used for OX mapping.

setCatalogback to summary
public void setCatalog(String catalog)

INTERNAL: Used for OX mapping.

setInitialValueback to summary
public void setInitialValue(Integer initialValue)

INTERNAL: Used for OX mapping.

setNameback to summary
public void setName(String name)

INTERNAL: Used for OX mapping.

setSchemaback to summary
public void setSchema(String schema)

INTERNAL: Used for OX mapping.

setSequenceNameback to summary
public void setSequenceName(String sequenceName)

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