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

public Class NoSqlMetadata

extends ORMetadata
Class Inheritance
Imports
jakarta.persistence.Table, org.eclipse.persistence.descriptors.ClassDescriptor, org.eclipse.persistence.eis.EISDescriptor, org.eclipse.persistence.internal.helper.Helper, 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, org.eclipse.persistence.internal.jpa.metadata.tables.TableMetadata
Defines the metadata for the @EIS annotation for mapping an EISDescriptor. Key notes: - any metadata mapped from XML to this class must be compared in the equals method. - any metadata mapped from XML to this class must be initialized in the initXMLObject 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
James Sutherland
Since
EclipseLink 2.4

Field Summary

Modifier and TypeField and Description
private String
dataFormat

private String
dataType

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

Constructor Summary

AccessConstructor and Description
public
NoSqlMetadata()

INTERNAL: Used for XML loading.

public
NoSqlMetadata(MetadataAnnotation struct, 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: Used for XML merging.
public String
getDataFormat()

INTERNAL: Used for OX mapping.

public String
getDataType()

INTERNAL: Used for OX mapping.

public int
hashCode()

Overrides java.lang.Object.hashCode.

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

INTERNAL: Switch the descriptor to the correct type and set the data-type name and format.

public void
setDataFormat(String dataFormat)

INTERNAL: Used for OX mapping.

public void
setDataType(String dataType)

INTERNAL: Used for OX mapping.

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

Field Detail

dataFormatback to summary
private String dataFormat
dataTypeback to summary
private String dataType

Constructor Detail

NoSqlMetadataback to summary
public NoSqlMetadata()

INTERNAL: Used for XML loading.

NoSqlMetadataback to summary
public NoSqlMetadata(MetadataAnnotation struct, 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: Used for XML merging.

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
getDataFormatback to summary
public String getDataFormat()

INTERNAL: Used for OX mapping.

getDataTypeback to summary
public String getDataType()

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

INTERNAL: Switch the descriptor to the correct type and set the data-type name and format.

setDataFormatback to summary
public void setDataFormat(String dataFormat)

INTERNAL: Used for OX mapping.

setDataTypeback to summary
public void setDataType(String dataType)

INTERNAL: Used for OX mapping.