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

public Class ColumnMetadata

extends DirectColumnMetadata
Class Inheritance
Known Direct Subclasses
org.eclipse.persistence.internal.jpa.metadata.columns.FieldMetadata
Imports
org.eclipse.persistence.internal.helper.DatabaseField, org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAnnotation
INTERNAL: Object to process a JPA column into an EclipseLink database field. 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_length

private Integer
m_precision

private Integer
m_scale

private String
m_table

private Boolean
m_unique

Constructor Summary

AccessConstructor and Description
public
ColumnMetadata()

INTERNAL: Used for XML loading.

protected
ColumnMetadata(String xmlElement)

INTERNAL: Used for XML loading.

public
ColumnMetadata(MetadataAccessor accessor)

INTERNAL: Used for defaulting.

public
ColumnMetadata(MetadataAnnotation column, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

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.columns.DirectColumnMetadata.equals.

INTERNAL:
public DatabaseField
getDatabaseField()

Overrides org.eclipse.persistence.internal.jpa.metadata.columns.DirectColumnMetadata.getDatabaseField.

INTERNAL:
public Integer
getLength()

INTERNAL: Used for OX mapping.

public Integer
getPrecision()

INTERNAL: Used for OX mapping.

public Integer
getScale()

INTERNAL: Used for OX mapping.

public String
getTable()

INTERNAL: Used for OX mapping.

public Boolean
getUnique()

INTERNAL: Used for OX mapping.

public int
hashCode()

Overrides org.eclipse.persistence.internal.jpa.metadata.columns.DirectColumnMetadata.hashCode.

Returns a hash code value for the object.
public void
setLength(Integer length)

INTERNAL: Used for OX mapping.

public void
setPrecision(Integer precision)

INTERNAL: Used for OX mapping.

public void
setScale(Integer scale)

INTERNAL: Used for OX mapping.

public void
setTable(String table)

INTERNAL: Used for OX mapping.

public void
setUnique(Boolean unique)

INTERNAL: Used for OX mapping.

Inherited from org.eclipse.persistence.internal.jpa.metadata.columns.DirectColumnMetadata:
getInsertablegetNullablegetUpdatablesetInsertablesetNullablesetUpdatable

Field Detail

m_lengthback to summary
private Integer m_length
m_precisionback to summary
private Integer m_precision
m_scaleback to summary
private Integer m_scale
m_tableback to summary
private String m_table
m_uniqueback to summary
private Boolean m_unique

Constructor Detail

ColumnMetadataback to summary
public ColumnMetadata()

INTERNAL: Used for XML loading.

ColumnMetadataback to summary
protected ColumnMetadata(String xmlElement)

INTERNAL: Used for XML loading.

ColumnMetadataback to summary
public ColumnMetadata(MetadataAccessor accessor)

INTERNAL: Used for defaulting.

ColumnMetadataback to summary
public ColumnMetadata(MetadataAnnotation column, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

Method Detail

equalsback to summary
public boolean equals(Object objectToCompare)

Overrides org.eclipse.persistence.internal.jpa.metadata.columns.DirectColumnMetadata.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
getDatabaseFieldback to summary
public DatabaseField getDatabaseField()

Overrides org.eclipse.persistence.internal.jpa.metadata.columns.DirectColumnMetadata.getDatabaseField.

INTERNAL:

Annotations
@Override
getLengthback to summary
public Integer getLength()

INTERNAL: Used for OX mapping.

getPrecisionback to summary
public Integer getPrecision()

INTERNAL: Used for OX mapping.

getScaleback to summary
public Integer getScale()

INTERNAL: Used for OX mapping.

getTableback to summary
public String getTable()

INTERNAL: Used for OX mapping.

getUniqueback to summary
public Boolean getUnique()

INTERNAL: Used for OX mapping.

hashCodeback to summary
public int hashCode()

Overrides org.eclipse.persistence.internal.jpa.metadata.columns.DirectColumnMetadata.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
setLengthback to summary
public void setLength(Integer length)

INTERNAL: Used for OX mapping.

setPrecisionback to summary
public void setPrecision(Integer precision)

INTERNAL: Used for OX mapping.

setScaleback to summary
public void setScale(Integer scale)

INTERNAL: Used for OX mapping.

setTableback to summary
public void setTable(String table)

INTERNAL: Used for OX mapping.

setUniqueback to summary
public void setUnique(Boolean unique)

INTERNAL: Used for OX mapping.