Module org.eclipse.persistence.jpa

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

Class SequenceGeneratorMetadata

java.lang.Object

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

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

public class SequenceGeneratorMetadata
extends ORMetadata

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.

Since:

TopLink EJB 3.0 Reference Implementation

Author:

Guy Pelletier

Field Summary

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

m_project

Constructor Summary

Constructors

Constructor	Description
SequenceGeneratorMetadata()	INTERNAL: Used for XML loading.
SequenceGeneratorMetadata(String sequenceName, Integer allocationSize, String catalog, String schema, boolean useIdentityIfPlatformSupports)	INTERNAL This constructor is used to create a default sequence generator.
SequenceGeneratorMetadata(String sequenceName, String catalog, String schema)	INTERNAL This constructor is used to create a default sequence generator.
SequenceGeneratorMetadata(MetadataAnnotation sequenceGenerator, MetadataAccessor accessor)	INTERNAL: Used for annotation loading.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	INTERNAL:
Integer	getAllocationSize()	INTERNAL: Used for OX mapping.
String	getCatalog()	INTERNAL: Used for OX mapping.
String	getCatalogContext()	INTERNAL:
String	getIdentifier()	INTERNAL: To satisfy the abstract getIdentifier() method from ORMetadata.
Integer	getInitialValue()	INTERNAL: Used for OX mapping.
String	getName()	INTERNAL: Used for OX mapping.
String	getSchema()	INTERNAL: Used for OX mapping.
String	getSchemaContext()	INTERNAL:
String	getSequenceName()	INTERNAL: Used for OX mapping.
int	hashCode()
NativeSequence	process(MetadataLogger logger)	INTERNAL:
String	processQualifier()	INTERNAL: Used for processing.
void	setAllocationSize(Integer allocationSize)	INTERNAL: Used for OX mapping.
void	setCatalog(String catalog)	INTERNAL: Used for OX mapping.
void	setInitialValue(Integer initialValue)	INTERNAL: Used for OX mapping.
void	setName(String name)	INTERNAL: Used for OX mapping.
void	setSchema(String schema)	INTERNAL: Used for OX mapping.
void	setSequenceName(String sequenceName)	INTERNAL: Used for OX mapping.
String	toString()	INTERNAL:

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

getAccessibleObject, getAccessibleObjectName, getAnnotation, getBoxedType, getDatabaseTypeEnum, getEntityMappings, getFullyQualifiedClassName, getJavaClass, getJavaClassName, getLoader, getLocation, getLogger, getMetadataClass, getMetadataClass, getMetadataClass, getMetadataFactory, getName, getPrimitiveClassForName, getProject, getText, getXMLElement, hasIdentifier, hasText, initXMLClassName, initXMLObject, initXMLObject, initXMLObjects, initXMLTextObject, loadedFromAnnotation, loadedFromEclipseLinkXML, loadedFromXML, merge, mergeORObjectLists, mergeORObjects, mergeSimpleObjects, reloadEntity, reloadMappedSuperclass, setAccessibleObject, setEntityMappings, setFieldName, setFieldName, setProject, shouldOverride, valuesMatch, valuesMatch

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SequenceGeneratorMetadata

public SequenceGeneratorMetadata()

INTERNAL: Used for XML loading.

SequenceGeneratorMetadata

public SequenceGeneratorMetadata(MetadataAnnotation sequenceGenerator,
                                 MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

SequenceGeneratorMetadata

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.

SequenceGeneratorMetadata

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

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

See Also:

processSequencingAccesssors.

Method Detail

equals

public boolean equals(Object objectToCompare)

INTERNAL:

Specified by:

equals in class ORMetadata

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getAllocationSize

public Integer getAllocationSize()

INTERNAL: Used for OX mapping.

getCatalog

public String getCatalog()

INTERNAL: Used for OX mapping.

getCatalogContext

public String getCatalogContext()

INTERNAL:

getIdentifier

public String getIdentifier()

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

Overrides:

getIdentifier in class ORMetadata

See Also:

ORMetadata.shouldOverride(ORMetadata), ORMetadata.mergeORObjects(ORMetadata, ORMetadata), ORMetadata.mergeORObjectLists(List, List)

getInitialValue

public Integer getInitialValue()

INTERNAL: Used for OX mapping.

getName

public String getName()

INTERNAL: Used for OX mapping.

getSchema

public String getSchema()

INTERNAL: Used for OX mapping.

getSchemaContext

public String getSchemaContext()

INTERNAL:

getSequenceName

public String getSequenceName()

INTERNAL: Used for OX mapping.

process

public NativeSequence process(MetadataLogger logger)

INTERNAL:

processQualifier

public String processQualifier()

INTERNAL: Used for processing.

setAllocationSize

public void setAllocationSize(Integer allocationSize)

INTERNAL: Used for OX mapping.

setCatalog

public void setCatalog(String catalog)

INTERNAL: Used for OX mapping.

setInitialValue

public void setInitialValue(Integer initialValue)

INTERNAL: Used for OX mapping.

setName

public void setName(String name)

INTERNAL: Used for OX mapping.

setSchema

public void setSchema(String schema)

INTERNAL: Used for OX mapping.

setSequenceName

public void setSequenceName(String sequenceName)

INTERNAL: Used for OX mapping.

toString

public String toString()

INTERNAL:

Overrides:

toString in class Object