com.sleepycat.persist.impl

Class ComplexFormat

java.lang.Object

com.sleepycat.persist.impl.Format

com.sleepycat.persist.impl.ComplexFormat

All Implemented Interfaces:

Reader, RawType, java.io.Serializable

public class ComplexFormat
extends Format

Format for persistent complex classes that are not composite key classes. This includes entity classes and subclasses.

Author:

Mark Hayes

See Also:

Serialized Form

Field Summary

Fields inherited from class com.sleepycat.persist.impl.Format

ID_BIGDEC, ID_BIGINT, ID_BOOL, ID_BOOL_W, ID_BYTE, ID_BYTE_W, ID_CHAR, ID_CHAR_W, ID_DATE, ID_DOUBLE, ID_DOUBLE_W, ID_FLOAT, ID_FLOAT_W, ID_INT, ID_INT_W, ID_LONG, ID_LONG_W, ID_NULL, ID_NUMBER, ID_OBJECT, ID_PREDEFINED, ID_SHORT, ID_SHORT_W, ID_SIMPLE_MAX, ID_SIMPLE_MIN, ID_STRING

Constructor Summary

Constructors

Constructor and Description
ComplexFormat(Catalog catalog, java.lang.Class cls, ClassMetadata clsMeta, EntityMetadata entityMeta)

Method Summary

Methods

Modifier and Type	Method and Description
(package private) void	collectRelatedFormats(Catalog catalog, java.util.Map<java.lang.String,Format> newFormats) Calls catalog.createFormat for formats that this format depends on, or that should also be persistent.
(package private) java.lang.Object	convertRawObject(Catalog catalog, boolean rawAccess, RawObject rawObject, IdentityHashMap converted) Converts a RawObject to a current class object and adds the converted pair to the converted map.
(package private) void	copySecMultiKey(RecordInput input, Format keyFormat, java.util.Set results) Called after skipToSecKey() to copy the data bytes of an array or collection (XXX_TO_MANY) key field.
(package private) boolean	evolve(Format newFormatParam, Evolver evolver) Called for an existing format that may not equal the current format for the same class.
(package private) boolean	evolveMetadata(Format newFormatParam, Converter converter, Evolver evolver) Called when a Converter handles evolution of a class, but we may still need to evolve the metadata.
Accessor	getAccessor(boolean rawAccess)
ClassMetadata	getClassMetadata() Returns the original model class metadata used to create this class, or null if this is not a model class.
(package private) ComplexFormat	getComplexSuper() Returns getSuperFormat cast to ComplexFormat.
(package private) ComplexFormat	getEntityFormat() For an entity class or subclass, returns the base entity class; returns null in other cases.
EntityMetadata	getEntityMetadata() Returns the original model entity metadata used to create this class, or null if this is not an entity class.
(package private) boolean	getEvolveNeeded() Overridden by ComplexFormat.
java.util.Map<java.lang.String,RawField>	getFields() Returns a map of field name to raw field for each non-static non-transient field declared in this class, or null if this is not a complex type (in other words, this is a simple type or an array type).
java.util.Set<java.lang.String>	getIncorrectlyOrderedSecKeys() For unit testing.
(package private) boolean	getNewStringFormat() For an entity format, returns whether the entity was written using the new String format.
java.lang.String	getOldKeyName(java.lang.String keyName) For an entity class or subclass, returns the old key name for the given key name that has been renamed, or returns the given key name if it has not been renamed.
(package private) java.lang.String	getPriKeyField()
(package private) FieldInfo	getPriKeyFieldInfo()
(package private) static SecondaryKeyMetadata	getSecondaryKeyMetadataByFieldName(java.util.Map<java.lang.String,SecondaryKeyMetadata> secKeys, java.lang.String fieldName) The secondary key metadata map (ClassMetadata.getSecondaryKeys) is keyed by key name, not field name.
(package private) void	initialize(Catalog catalog, EntityModel model, int initVersion) Initializes an uninitialized format, initializing its related formats (superclass formats and array component formats) first.
(package private) boolean	isEntity() Returns whether this format class is an entity class.
(package private) boolean	isModelClass() Returns whether this class is present in the EntityModel.
(package private) boolean	isPriKeyNullOrZero(java.lang.Object o, boolean rawAccess) Returns whether the entity's primary key field is null or zero, as defined for primary keys that are assigned from a sequence.
(package private) boolean	isSecKeyIncorrectlyOrdered(java.lang.String keyName) Called when opening an existing secondary database that should have a dup comparator configured.
(package private) void	migrateFromBeta(java.util.Map<java.lang.String,Format> formatMap) Special handling for JE 3.0.12 beta formats.
(package private) java.lang.Object	newArray(int len) Creates an array of the format's class of the given length, as if Array.newInstance(getType(), len) were called.
java.lang.Object	newInstance(EntityInput input, boolean rawAccess) Creates a new instance of the target class using its default constructor.
(package private) boolean	nullifySecKey(Catalog catalog, java.lang.Object entity, java.lang.String keyName, java.lang.Object keyElement) Nullifies the given key field in the given RawObject -- rawAccess mode is implied.
java.lang.Object	readObject(java.lang.Object o, EntityInput input, boolean rawAccess) Called after newInstance() to read the rest of the data bytes and fill in the object contents.
void	readPriKey(java.lang.Object o, EntityInput input, boolean rawAccess) Reads the primary key from the given input bytes and sets the primary key field in the given object.
(package private) void	setEvolveNeeded(boolean needed) Called by the Evolver with true when an entity format or any of its nested format were changed.
(package private) boolean	setSecKeyCorrectlyOrdered(java.lang.String keyName) Called when creating a new secondary database that should have a dup comparator configured.
(package private) void	skipContents(RecordInput input) Skips over the object's contents, as if readObject() were called, but without returning an object.
(package private) Format	skipToSecKey(RecordInput input, java.lang.String keyName) When extracting a secondary key, called to skip over all fields up to the given secondary key field.
(package private) void	writeObject(java.lang.Object o, EntityOutput output, boolean rawAccess) Writes a given instance of the target class to the output data bytes.
(package private) void	writePriKey(java.lang.Object o, EntityOutput output, boolean rawAccess) Gets the primary key field from the given object and writes it to the given output data bytes.

Methods inherited from class com.sleepycat.persist.impl.Format

allowEvolveFromProxy, areNestedRefsProhibited, copySecKey, getCatalog, getClassName, getComponentType, getDimensions, getEnumConstants, getExistingType, getId, getLatestVersion, getPreviousVersion, getProxiedFormat, getReader, getSequenceKeyFormat, getSuperFormat, getSuperType, getType, getVersion, getWrapperFormat, initCatalog, initializeIfNeeded, initializeReader, isArray, isAssignableTo, isCurrentVersion, isDeleted, isEnum, isInitialized, isNew, isPredefined, isPrimitive, isSameClass, isSimple, setDeleted, setId, setLatestVersion, setProxiedFormat, setReader, setSuperFormat, setUnused, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ComplexFormat

ComplexFormat(Catalog catalog,
             java.lang.Class cls,
             ClassMetadata clsMeta,
             EntityMetadata entityMeta)

Method Detail

migrateFromBeta

void migrateFromBeta(java.util.Map<java.lang.String,Format> formatMap)

Description copied from class: Format

Special handling for JE 3.0.12 beta formats.

Overrides:

migrateFromBeta in class Format

getComplexSuper

ComplexFormat getComplexSuper()

Returns getSuperFormat cast to ComplexFormat. It is guaranteed that all super formats of a ComplexFormat are a ComplexFormat.

getPriKeyFieldInfo

FieldInfo getPriKeyFieldInfo()

getPriKeyField

java.lang.String getPriKeyField()

isEntity

boolean isEntity()

Description copied from class: Format

Returns whether this format class is an entity class.

Overrides:

isEntity in class Format

isModelClass

boolean isModelClass()

Description copied from class: Format

Returns whether this class is present in the EntityModel. Returns false for a simple type, array type, or enum type.

Overrides:

isModelClass in class Format

getClassMetadata

public ClassMetadata getClassMetadata()

Description copied from interface: RawType

Returns the original model class metadata used to create this class, or null if this is not a model class.

Specified by:

getClassMetadata in interface RawType

Overrides:

getClassMetadata in class Format

getEntityMetadata

public EntityMetadata getEntityMetadata()

Description copied from interface: RawType

Returns the original model entity metadata used to create this class, or null if this is not an entity class.

Specified by:

getEntityMetadata in interface RawType

Overrides:

getEntityMetadata in class Format

getEntityFormat

ComplexFormat getEntityFormat()

Description copied from class: Format

For an entity class or subclass, returns the base entity class; returns null in other cases.

Overrides:

getEntityFormat in class Format

setEvolveNeeded

void setEvolveNeeded(boolean needed)

Description copied from class: Format

Called by the Evolver with true when an entity format or any of its nested format were changed. Called by Store.evolve when an entity has been fully converted. Overridden by ComplexFormat.

Overrides:

setEvolveNeeded in class Format

getEvolveNeeded

boolean getEvolveNeeded()

Description copied from class: Format

Overridden by ComplexFormat.

Overrides:

getEvolveNeeded in class Format

getNewStringFormat

boolean getNewStringFormat()

Description copied from class: Format

For an entity format, returns whether the entity was written using the new String format. For a non-entity format, this method should not be called. Overridden by ComplexFormat.

Overrides:

getNewStringFormat in class Format

getFields

public java.util.Map<java.lang.String,RawField> getFields()

Description copied from interface: RawType

Returns a map of field name to raw field for each non-static non-transient field declared in this class, or null if this is not a complex type (in other words, this is a simple type or an array type).

Specified by:

getFields in interface RawType

Overrides:

getFields in class Format

collectRelatedFormats

void collectRelatedFormats(Catalog catalog,
                         java.util.Map<java.lang.String,Format> newFormats)

Description copied from class: Format

Calls catalog.createFormat for formats that this format depends on, or that should also be persistent.

Specified by:

collectRelatedFormats in class Format

initialize

void initialize(Catalog catalog,
              EntityModel model,
              int initVersion)

Description copied from class: Format

Initializes an uninitialized format, initializing its related formats (superclass formats and array component formats) first.

Specified by:

initialize in class Format

newArray

java.lang.Object newArray(int len)

Description copied from class: Format

Creates an array of the format's class of the given length, as if Array.newInstance(getType(), len) were called. Formats implement this method for specific classes, or call the accessor, to avoid the reflection overhead of Array.newInstance.

Specified by:

newArray in class Format

newInstance

public java.lang.Object newInstance(EntityInput input,
                           boolean rawAccess)

Description copied from class: Format

Creates a new instance of the target class using its default constructor. Normally this creates an empty object, and readObject() is called next to fill in the contents. This is done in two steps to allow the instance to be registered by EntityInput before reading the contents. This allows the fields in an object or a nested object to refer to the parent object in a graph. Alternatively, this method may read all or the first portion of the data, rather than that being done by readObject(). This is required for simple types and enums, where the object cannot be created without reading the data. In these cases, there is no possibility that the parent object will be referenced by the child object in the graph. It should not be done in other cases, or the graph references may not be maintained faithfully. Is public only in order to implement the Reader interface. Note that this method should only be called directly in raw conversion mode or during conversion of an old format. Normally it should be called via the getReader method and the Reader interface.

Specified by:

newInstance in interface Reader

Specified by:

newInstance in class Format

readObject

public java.lang.Object readObject(java.lang.Object o,
                          EntityInput input,
                          boolean rawAccess)
                            throws RefreshException

Description copied from class: Format

Called after newInstance() to read the rest of the data bytes and fill in the object contents. If the object was read completely by newInstance(), this method does nothing. Is public only in order to implement the Reader interface. Note that this method should only be called directly in raw conversion mode or during conversion of an old format. Normally it should be called via the getReader method and the Reader interface.

Specified by:

readObject in interface Reader

Specified by:

readObject in class Format

Throws:

RefreshException

writeObject

void writeObject(java.lang.Object o,
               EntityOutput output,
               boolean rawAccess)
           throws RefreshException

Description copied from class: Format

Writes a given instance of the target class to the output data bytes. This is the complement of the newInstance()/readObject() pair.

Specified by:

writeObject in class Format

Throws:

RefreshException

convertRawObject

java.lang.Object convertRawObject(Catalog catalog,
                                boolean rawAccess,
                                RawObject rawObject,
                                IdentityHashMap converted)
                            throws RefreshException

Description copied from class: Format

Converts a RawObject to a current class object and adds the converted pair to the converted map.

Overrides:

convertRawObject in class Format

Throws:

RefreshException

isPriKeyNullOrZero

boolean isPriKeyNullOrZero(java.lang.Object o,
                         boolean rawAccess)

Description copied from class: Format

Returns whether the entity's primary key field is null or zero, as defined for primary keys that are assigned from a sequence.

Overrides:

isPriKeyNullOrZero in class Format

writePriKey

void writePriKey(java.lang.Object o,
               EntityOutput output,
               boolean rawAccess)
           throws RefreshException

Description copied from class: Format

Gets the primary key field from the given object and writes it to the given output data bytes. This is a separate operation because the primary key data bytes are stored separately from the rest of the record.

Overrides:

writePriKey in class Format

Throws:

RefreshException

readPriKey

public void readPriKey(java.lang.Object o,
              EntityInput input,
              boolean rawAccess)
                throws RefreshException

Description copied from class: Format

Reads the primary key from the given input bytes and sets the primary key field in the given object. This is complement of writePriKey(). Is public only in order to implement the Reader interface. Note that this method should only be called directly in raw conversion mode or during conversion of an old format. Normally it should be called via the getReader method and the Reader interface.

Specified by:

readPriKey in interface Reader

Overrides:

readPriKey in class Format

Throws:

RefreshException

getOldKeyName

public java.lang.String getOldKeyName(java.lang.String keyName)

Description copied from class: Format

For an entity class or subclass, returns the old key name for the given key name that has been renamed, or returns the given key name if it has not been renamed.

Overrides:

getOldKeyName in class Format

nullifySecKey

boolean nullifySecKey(Catalog catalog,
                    java.lang.Object entity,
                    java.lang.String keyName,
                    java.lang.Object keyElement)

Description copied from class: Format

Nullifies the given key field in the given RawObject -- rawAccess mode is implied.

Overrides:

nullifySecKey in class Format

skipContents

void skipContents(RecordInput input)
            throws RefreshException

Description copied from class: Format

Skips over the object's contents, as if readObject() were called, but without returning an object. Used for extracting secondary key bytes without having to instantiate the object. For reference types, the format ID is read just before calling this method, so this method is responsible for skipping everything following the format ID.

Specified by:

skipContents in class Format

Throws:

RefreshException

copySecMultiKey

void copySecMultiKey(RecordInput input,
                   Format keyFormat,
                   java.util.Set results)
               throws RefreshException

Description copied from class: Format

Called after skipToSecKey() to copy the data bytes of an array or collection (XXX_TO_MANY) key field.

Overrides:

copySecMultiKey in class Format

Throws:

RefreshException

skipToSecKey

Format skipToSecKey(RecordInput input,
                  java.lang.String keyName)
              throws RefreshException

Description copied from class: Format

When extracting a secondary key, called to skip over all fields up to the given secondary key field. Returns the format of the key field found, or null if the field is not present (nullified) in the object.

Overrides:

skipToSecKey in class Format

Throws:

RefreshException

evolve

boolean evolve(Format newFormatParam,
             Evolver evolver)

Description copied from class: Format

Called for an existing format that may not equal the current format for the same class.

If this method returns true, then it must have determined one of two things: - that the old and new formats are equal, and it must have called Evolver.useOldFormat; or - that the old format can be evolved to the new format, and it must have called Evolver.useEvolvedFormat.

If this method returns false, then it must have determined that the old format could not be evolved to the new format, and it must have called Evolver.addInvalidMutation, addMissingMutation or addEvolveError.

Specified by:

evolve in class Format

evolveMetadata

boolean evolveMetadata(Format newFormatParam,
                     Converter converter,
                     Evolver evolver)

Description copied from class: Format

Called when a Converter handles evolution of a class, but we may still need to evolve the metadata.

Overrides:

evolveMetadata in class Format

getSecondaryKeyMetadataByFieldName

static SecondaryKeyMetadata getSecondaryKeyMetadataByFieldName(java.util.Map<java.lang.String,SecondaryKeyMetadata> secKeys,
                                                      java.lang.String fieldName)

The secondary key metadata map (ClassMetadata.getSecondaryKeys) is keyed by key name, not field name. Key name can be different than field name when a @SecondaryKey name property is specified. To look up metadata by field name, we must do a linear search. Luckily, the number of keys per class is never very large. [#16819]

isSecKeyIncorrectlyOrdered

boolean isSecKeyIncorrectlyOrdered(java.lang.String keyName)

Called when opening an existing secondary database that should have a dup comparator configured. If true is returned, then this secondary index may have been previously opened without a dup comparator set, and therefore no dup comparator should be set on this database. If false is returned, the dup comparator should be set by the caller.

setSecKeyCorrectlyOrdered

boolean setSecKeyCorrectlyOrdered(java.lang.String keyName)

Called when creating a new secondary database that should have a dup comparator configured. If true is returned, then this secondary index may have been previously opened without a dup comparator set; this method will update this format to indicate that the dup comparator is now allowed, and the caller should flush the catalog. If false is returned, the caller need not flush the catalog.

getIncorrectlyOrderedSecKeys

public java.util.Set<java.lang.String> getIncorrectlyOrderedSecKeys()

For unit testing.

getAccessor

public Accessor getAccessor(boolean rawAccess)

Specified by:

getAccessor in interface Reader

Overrides:

getAccessor in class Format