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

public Class JoinColumnMetadata

extends RelationalColumnMetadata
Class Inheritance
Known Direct Subclasses
org.eclipse.persistence.internal.jpa.metadata.columns.JoinFieldMetadata
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 JPA join columns EclipseLink database fields. 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 Boolean
m_insertable

private Boolean
m_nullable

private String
m_table

private Boolean
m_unique

private Boolean
m_updatable

Constructor Summary

AccessConstructor and Description
public
JoinColumnMetadata()

INTERNAL: Used for XML loading.

protected
JoinColumnMetadata(String xmlElement)

INTERNAL: Used for XML loading.

public
JoinColumnMetadata(MetadataAnnotation joinColumn, 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.RelationalColumnMetadata.equals.

INTERNAL:
protected DatabaseField
getForeignKeyField()

Overrides org.eclipse.persistence.internal.jpa.metadata.columns.RelationalColumnMetadata.getForeignKeyField.

INTERNAL:
public Boolean
getInsertable()

INTERNAL: Used for OX mapping.

public Boolean
getNullable()

INTERNAL: Used for OX mapping.

public String
getTable()

INTERNAL: USed for OX mapping.

public Boolean
getUnique()

INTERNAL: Used for OX mapping.

public Boolean
getUpdatable()

INTERNAL: Used for OX mapping.

public int
hashCode()

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

Returns a hash code value for the object.
public void
setInsertable(Boolean insertable)

INTERNAL: Used for OX mapping.

public void
setNullable(Boolean nullable)

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.

public void
setUpdatable(Boolean updatable)

INTERNAL: Used for OX mapping.

Inherited from org.eclipse.persistence.internal.jpa.metadata.columns.RelationalColumnMetadata:
getForeignKeygetForeignKeyFieldgetReferencedColumnNamehasForeignKeyisForeignKeyFieldNotSpecifiedisPrimaryKeyFieldNotSpecifiedsetForeignKeysetReferencedColumnName

Field Detail

m_insertableback to summary
private Boolean m_insertable
m_nullableback to summary
private Boolean m_nullable
m_tableback to summary
private String m_table
m_uniqueback to summary
private Boolean m_unique
m_updatableback to summary
private Boolean m_updatable

Constructor Detail

JoinColumnMetadataback to summary
public JoinColumnMetadata()

INTERNAL: Used for XML loading.

JoinColumnMetadataback to summary
protected JoinColumnMetadata(String xmlElement)

INTERNAL: Used for XML loading.

JoinColumnMetadataback to summary
public JoinColumnMetadata(MetadataAnnotation joinColumn, 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.RelationalColumnMetadata.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
getForeignKeyFieldback to summary
protected DatabaseField getForeignKeyField()

Overrides org.eclipse.persistence.internal.jpa.metadata.columns.RelationalColumnMetadata.getForeignKeyField.

INTERNAL:

Annotations
@Override
getInsertableback to summary
public Boolean getInsertable()

INTERNAL: Used for OX mapping.

getNullableback to summary
public Boolean getNullable()

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.

getUpdatableback to summary
public Boolean getUpdatable()

INTERNAL: Used for OX mapping.

hashCodeback to summary
public int hashCode()

Overrides org.eclipse.persistence.internal.jpa.metadata.columns.RelationalColumnMetadata.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
setInsertableback to summary
public void setInsertable(Boolean insertable)

INTERNAL: Used for OX mapping.

setNullableback to summary
public void setNullable(Boolean nullable)

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.

setUpdatableback to summary
public void setUpdatable(Boolean updatable)

INTERNAL: Used for OX mapping.