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

public Class AdditionalCriteriaMetadata

extends ORMetadata
Class Inheritance
Imports
org.eclipse.persistence.internal.jpa.metadata.MetadataDescriptor, .ORMetadata, org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAnnotation
Object to hold onto additional criteria 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 2.2

Field Summary

Modifier and TypeField and Description
protected String
m_criteria

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

Constructor Summary

AccessConstructor and Description
public
AdditionalCriteriaMetadata()

INTERNAL: Used for XML loading.

public
AdditionalCriteriaMetadata(MetadataAnnotation additionalCriteria, 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)

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

INTERNAL:
public String
getCriteria()

INTERNAL: Used for OX mapping.

public String
getIdentifier()

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

INTERNAL: The unique identifier of additional criteria is the criteria itself.
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public void
process(MetadataDescriptor descriptor)

INTERNAL:

public void
setCriteria(String criteria)

INTERNAL: Used for OX mapping.

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

Field Detail

m_criteriaback to summary
protected String m_criteria

Constructor Detail

AdditionalCriteriaMetadataback to summary
public AdditionalCriteriaMetadata()

INTERNAL: Used for XML loading.

AdditionalCriteriaMetadataback to summary
public AdditionalCriteriaMetadata(MetadataAnnotation additionalCriteria, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

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
getCriteriaback to summary
public String getCriteria()

INTERNAL: Used for OX mapping.

getIdentifierback to summary
public String getIdentifier()

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

INTERNAL: The unique identifier of additional criteria is the criteria itself.

Annotations
@Override
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 void process(MetadataDescriptor descriptor)

INTERNAL:

setCriteriaback to summary
public void setCriteria(String criteria)

INTERNAL: Used for OX mapping.