| java.lang.Object
 com.sleepycat.persist.impl.Format
All known Subclasses: com.sleepycat.persist.impl.PrimitiveArrayFormat, com.sleepycat.persist.impl.NonPersistentFormat, com.sleepycat.persist.impl.CompositeKeyFormat, com.sleepycat.persist.impl.EnumFormat, com.sleepycat.persist.impl.ProxiedFormat, com.sleepycat.persist.impl.ObjectArrayFormat, com.sleepycat.persist.impl.ComplexFormat, com.sleepycat.persist.impl.SimpleFormat,
| Format | | abstract public class Format implements Reader,RawType,Serializable(Code) | | The base class for all object formats. Formats are used to define the
stored layout for all persistent classes, including simple types.
The design documentation below describes the storage format for entities and
its relationship to information stored per format in the catalog.
Requirements
------------
+ Provides EntityBinding for objects and EntryBinding for keys.
+ Provides SecondaryKeyCreator, SecondaryMultiKeyCreator and
SecondaryMultiKeyNullifier (SecondaryKeyNullifier is redundant).
+ Works with reflection and bytecode enhancement.
+ For reflection only, works with any entity model not just annotations.
+ Bindings are usable independently of the persist API.
+ Performance is almost equivalent to hand coded tuple bindings.
+ Small performance penalty for compatible class changes (new fields,
widening).
+ Secondary key create/nullify do not have to deserialize the entire record;
in other words, store secondary keys at the start of the data.
Class Format
------------
Every distinct class format is given a unique format ID. Class IDs are not
equivalent to class version numbers (as in the version property of @Entity
and @Persistent) because the format can change when the version number does
not. Changes that cause a unique format ID to be assigned are:
+ Add field.
+ Widen field type.
+ Change primitive type to primitive wrapper class.
+ Add or drop secondary key.
+ Any incompatible class change.
The last item, incompatible class changes, also correspond to a class
version change.
For each distinct class format the following information is conceptually
stored in the catalog, keyed by format ID.
- Class name
- Class version number
- Superclass format
- Kind: simple, enum, complex, array
- For kind == simple:
- Primitive class
- For kind == enum:
- Array of constant names, sorted by name.
- For kind == complex:
- Primary key fieldInfo, or null if no primary key is declared
- Array of secondary key fieldInfo, sorted by field name
- Array of other fieldInfo, sorted by field name
- For kind == array:
- Component class format
- Number of array dimensions
- Other metadata for RawType
Where fieldInfo is:
- Field name
- Field class
- Other metadata for RawField
Data Layout
-----------
For each entity instance the data layout is as follows:
instanceData: formatId keyFields... nonKeyFields...
keyFields: fieldValue...
nonKeyFields: fieldValue...
The formatId is the (positive non-zero) ID of a class format, defined above.
This is ID of the most derived class of the instance. It is stored as a
packed integer.
Following the format ID, zero or more sets of secondary key field values
appear, followed by zero or more sets of other class field values.
The keyFields are the sets of secondary key fields for each class in order
of the highest superclass first. Within a class, fields are ordered by
field name.
The nonKeyFields are the sets of other non-key fields for each class in
order of the highest superclass first. Within a class, fields are ordered
by field name.
A field value is:
fieldValue: primitiveValue
| nullId
| instanceRef
| instanceData
| simpleValue
| enumValue
| arrayValue
For a primitive type, a primitive value is used as defined for tuple
bindings. For float and double, sorted float and sorted double tuple values
are used.
For a non-primitive type with a null value, a nullId is used that has a zero
(illegal formatId) value. This includes String and other simple reference
types. The formatId is stored as a packed integer, meaning that it is
stored as a single zero byte.
For a non-primitive type, an instanceRef is used for a non-null instance
that appears earlier in the data byte array. An instanceRef is the negation
of the byte offset of the instanceData that appears earlier. It is stored
as a packed integer.
The remaining rules apply only to reference types with non-null values that
do not appear earlier in the data array.
For an array type, an array formatId is used that identifies the component
type and the number of array dimensions. This is followed by an array
length (stored as a packed integer) and zero or more fieldValue elements.
For an array with N+1 dimensions where N is greater than zero, the leftmost
dimension is enumerated such that each fieldValue element is itself an array
of N dimensions or null.
arrayValue: formatId length fieldValue...
For an enum type, an enumValue is used, consisting of a formatId that
identifies the enum class and an enumIndex (stored as a packed integer) that
identifies the constant name in the enum constant array of the enum class
format:
enumValue: formatId enumIndex
For a simple type, a simpleValue is used. This consists of the formatId
that identifies the class followed by the simple type value. For a
primitive wrapper type the simple type value is the corresponding primitive,
for a Date it is the milliseconds as a long primitive, and for BigInteger or
BigDecimal it is a byte array as defined for tuple bindings of these types.
simpleValue: formatId value
For all other complex types, an instanceData is used, which is defined
above.
Secondary Keys
--------------
For secondary key support we must account for writing and nullifying
specific keys. Rather than instantiating the entity and then performing
the secondary key operation, we strive to perform the secondary key
operation directly on the byte format.
To create a secondary key we skip over other fields and then copy the bytes
of the embedded key. This approach is very efficient because a) the entity
is not instantiated, and b) the secondary keys are stored at the beginning
of the byte format and can be quickly read.
To nullify we currently instantiate the raw entity, set the key field to null
(or remove it from the array/collection), and convert the raw entity back to
bytes. Although the performance of this approach is not ideal because it
requires serialization, it avoids the complexity of modifying the packed
serialized format directly, adjusting references to key objects, etc. Plus,
when we nullify a key we are going to write the record, so the serialization
overhead may not be significant. For the record, I tried implementing
nullification of the bytes directly and found it was much too complex.
Lifecycle
---------
Format are managed by a Catalog class. Simple formats are managed by
SimpleCatalog, and are copied from the SimpleCatalog by PersistCatalog.
Other formats are managed by PersistCatalog. The lifecycle of a format
instance is:
- Constructed by the catalog when a format is requested for a Class
that currently has no associated format.
- The catalog calls setId() and adds the format to its format list
(indexed by format id) and map (keyed by class name).
- The catalog calls collectRelatedFormats(), where a format can create
additional formats that it needs, or that should also be persistent.
- The catalog calls initializeIfNeeded(), which calls the initialize()
method of the format class.
- initialize() should initialize any transient fields in the format.
initialize() can assume that all related formats are available in the
catalog. It may call initializeIfNeeded() for those related formats, if
it needs to interact with an initialized related format; this does not
cause a cycle, because initializeIfNeeded() does nothing for an already
initialized format.
- The catalog creates a group of related formats at one time, and then
writes its entire list of formats to the catalog DB as a single record.
This grouping reduces the number of writes.
- When a catalog is opened and the list of existing formats is read. After
a format is deserialized, its initializeIfNeeded() method is called.
setId() and collectRelatedFormats() are not called, since the ID and
related formats are stored in serialized fields.
- There are two modes for opening an existing catalog: raw mode and normal
mode. In raw mode, the old format is used regardless of whether it
matches the current class definition; in fact the class is not accessed
and does not need to be present.
- In normal mode, for each existing format that is initialized, a new format
is also created based on the current class and metadata definition. If
the two formats are equal, the new format is discarded. If they are
unequal, the new format becomes the current format and the old format's
evolve() method is called. evolve() is responsible for adjusting the
old format for class evolution. Any number of non-current formats may
exist for a given class, and are setup to evolve the single current format
for the class.
author:
Mark Hayes |
| Constructor Summary | |
| | Format(Class type)
Creates a new format for a given class. | | | Format(String className)
Creates a format for class evolution when no class may be present. |
| Method Summary | |
| boolean | areNestedRefsProhibited()
Certain formats (ProxiedFormat for example) prohibit nested fields that
reference the parent object. | | abstract void | collectRelatedFormats(Catalog catalog, Map<String, Format> newFormats)
Calls catalog.createFormat for formats that this format depends on, or
that should also be persistent. | | 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. | | void | copySecKey(RecordInput input, RecordOutput output)
Called after skipToSecKey() to copy the data bytes of a singular
(XXX_TO_ONE) key field. | | void | copySecMultiKey(RecordInput input, Format keyFormat, Set results)
Called after skipToSecKey() to copy the data bytes of an array or
collection (XXX_TO_MANY) key field. | | abstract boolean | evolve(Format newFormat, Evolver evolver)
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 that the
old and new formats are equal, and it must have called either
Evolver.useOldFormat or useEvolvedFormat. | | boolean | evolveMetadata(Format newFormat, Converter converter, Evolver evolver)
Called when a Converter handles evolution of a class, but we may still
need to evolve the metadata. | | final Catalog | getCatalog()
| | ClassMetadata | getClassMetadata()
Returns the original model class metadata used to create this class, or
null if this is not a model class. | | public String | getClassName()
| | public Format | getComponentType()
| | public int | getDimensions()
| | Format | 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. | | public List<String> | getEnumConstants()
| | boolean | getEvolveNeeded()
Overridden by ComplexFormat. | | final Class | getExistingType()
Called to get the type when it is known to exist for an uninitialized
format. | | public Map<String, RawField> | getFields()
| | final int | getId()
Returns the format ID. | | final Format | getLatestVersion()
If this is the latest/evolved format, returns this; otherwise, returns
the current version of this format. | | final public Format | getPreviousVersion()
Returns the previous version of this format in the linked list of
versions, or null if this is the only version. | | final Format | getProxiedFormat()
Returns the format that is proxied by this format. | | final Reader | getReader()
Returns the object for reading objects of the latest format. | | Format | getSequenceKeyFormat()
Validates and returns the simple integer key format for a sequence key
associated with this format.
For a composite key type, the format of the one and only field is
returned. | | final Format | getSuperFormat()
Returns the format of the superclass. | | public Format | getSuperType()
| | final Class | getType()
Returns the class that this format represents. | | public int | getVersion()
| | Format | getWrapperFormat()
For primitive types only, returns their associated wrapper type. | | abstract void | initialize(Catalog catalog, int initVersion)
Initializes an uninitialized format, initializing its related formats
(superclass formats and array component formats) first. | | final void | initializeIfNeeded(Catalog catalog)
Called by the Catalog to initialize a format, and may also be called
during initialize() for a related format to ensure that the related
format is initialized. | | public void | initializeReader(Catalog catalog, int initVersion, Format oldFormat)
Called to initialize a separate Reader implementation. | | public boolean | isArray()
| | boolean | isAssignableTo(Format format)
Called by EntityOutput in rawAccess mode to determine whether an object
type is allowed to be assigned to a given field type. | | final boolean | isCurrentVersion()
Returns whether this format is the current format for its class. | | final boolean | isDeleted()
Returns whether the class for this format was deleted. | | boolean | isEntity()
Returns whether this format class is an entity class. | | public boolean | isEnum()
| | final boolean | isInitialized()
| | boolean | isModelClass()
Returns whether this class is present in the EntityModel. | | final boolean | isNew()
| | static boolean | isPredefined(Format format)
| | boolean | isPriKeyNullOrZero(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. | | public boolean | isPrimitive()
| | final boolean | isSameClass(Format other)
Returns whether this format has the same class as the given format,
irrespective of version changes and renaming. | | public boolean | isSimple()
| | void | migrateFromBeta(Map<String, Format> formatMap)
Special handling for JE 3.0.12 beta formats. | | abstract Object | newArray(int len)
Creates an array of the format's class of the given length, as if
Array.newInstance(getType(), len) were called. | | abstract public Object | newInstance(EntityInput input, boolean rawAccess)
Creates a new instance of the target class using its default
constructor. | | boolean | nullifySecKey(Catalog catalog, Object entity, String keyName, Object keyElement)
Nullifies the given key field in the given RawObject -- rawAccess mode
is implied. | | abstract public Object | readObject(Object o, EntityInput input, boolean rawAccess)
Called after newInstance() to read the rest of the data bytes and fill
in the object contents. | | public void | readPriKey(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. | | final void | setDeleted(boolean deleted)
Called by the Evolver when applying a Deleter mutation. | | void | setEvolveNeeded(boolean needed)
Called by the Evolver with true when an entity format or any of its
nested format were changed. | | final void | setId(int id)
Called by the Catalog to set the format ID when a new format is added to
the format list, before calling initializeIfNeeded(). | | final void | setLatestVersion(Format newFormat)
Called by Evolver to set the latest format when this old format is
evolved. | | final void | setProxiedFormat(Format proxiedFormat)
Called by ProxiedFormat to set the proxied format. | | final void | setReader(Reader reader)
Changes the reader during format evolution. | | final void | setSuperFormat(Format superFormat)
Called to set the format of the superclass during initialize(). | | final void | setUnused(boolean unused)
Called by the Evolver for a format that is never referenced. | | abstract void | skipContents(RecordInput input)
Skips over the object's contents, as if readObject() were called, but
without returning an object. | | Format | skipToSecKey(RecordInput input, String keyName)
When extracting a secondary key, called to skip over all fields up to
the given secondary key field. | | public String | toString()
| | abstract void | writeObject(Object o, EntityOutput output, boolean rawAccess)
Writes a given instance of the target class to the output data bytes. | | void | writePriKey(Object o, EntityOutput output, boolean rawAccess)
Gets the primary key field from the given object and writes it to the
given output data bytes. |
| ID_BIGDEC | | final static int ID_BIGDEC(Code) | | BigDecimal
|
| ID_BIGINT | | final static int ID_BIGINT(Code) | | BigInteger
|
| ID_BOOL | | final static int ID_BOOL(Code) | | Boolean
|
| ID_BOOL_W | | final static int ID_BOOL_W(Code) | | |
| ID_BYTE | | final static int ID_BYTE(Code) | | Byte
|
| ID_BYTE_W | | final static int ID_BYTE_W(Code) | | |
| ID_CHAR | | final static int ID_CHAR(Code) | | Character
|
| ID_CHAR_W | | final static int ID_CHAR_W(Code) | | |
| ID_DATE | | final static int ID_DATE(Code) | | Date
|
| ID_DOUBLE | | final static int ID_DOUBLE(Code) | | Double
|
| ID_DOUBLE_W | | final static int ID_DOUBLE_W(Code) | | |
| ID_FLOAT | | final static int ID_FLOAT(Code) | | Float
|
| ID_FLOAT_W | | final static int ID_FLOAT_W(Code) | | |
| ID_INT | | final static int ID_INT(Code) | | Integer
|
| ID_INT_W | | final static int ID_INT_W(Code) | | |
| ID_LONG | | final static int ID_LONG(Code) | | Long
|
| ID_LONG_W | | final static int ID_LONG_W(Code) | | |
| ID_NULL | | final static int ID_NULL(Code) | | Null reference.
|
| ID_NUMBER | | final static int ID_NUMBER(Code) | | Number
|
| ID_OBJECT | | final static int ID_OBJECT(Code) | | Object
|
| ID_PREDEFINED | | final static int ID_PREDEFINED(Code) | | Last predefined ID, after which dynamic IDs are assigned.
|
| ID_SHORT | | final static int ID_SHORT(Code) | | Short
|
| ID_SHORT_W | | final static int ID_SHORT_W(Code) | | |
| ID_SIMPLE_MAX | | final static int ID_SIMPLE_MAX(Code) | | Last simple type.
|
| ID_SIMPLE_MIN | | final static int ID_SIMPLE_MIN(Code) | | First simple type.
|
| ID_STRING | | final static int ID_STRING(Code) | | String
|
| Format | | Format(Class type)(Code) | | Creates a new format for a given class.
|
| Format | | Format(String className)(Code) | | Creates a format for class evolution when no class may be present.
|
| areNestedRefsProhibited | | boolean areNestedRefsProhibited()(Code) | | Certain formats (ProxiedFormat for example) prohibit nested fields that
reference the parent object. [#15815]
|
| collectRelatedFormats | | abstract void collectRelatedFormats(Catalog catalog, Map<String, Format> newFormats)(Code) | | Calls catalog.createFormat for formats that this format depends on, or
that should also be persistent.
|
| convertRawObject | | Object convertRawObject(Catalog catalog, boolean rawAccess, RawObject rawObject, IdentityHashMap converted)(Code) | | Converts a RawObject to a current class object and adds the converted
pair to the converted map.
|
| copySecKey | | void copySecKey(RecordInput input, RecordOutput output)(Code) | | Called after skipToSecKey() to copy the data bytes of a singular
(XXX_TO_ONE) key field.
|
| copySecMultiKey | | void copySecMultiKey(RecordInput input, Format keyFormat, Set results)(Code) | | Called after skipToSecKey() to copy the data bytes of an array or
collection (XXX_TO_MANY) key field.
|
| evolve | | abstract boolean evolve(Format newFormat, Evolver evolver)(Code) | | 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 that the
old and new formats are equal, and it must have called either
Evolver.useOldFormat or 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.
|
| evolveMetadata | | boolean evolveMetadata(Format newFormat, Converter converter, Evolver evolver)(Code) | | Called when a Converter handles evolution of a class, but we may still
need to evolve the metadata.
|
| getClassMetadata | | ClassMetadata getClassMetadata()(Code) | | Returns the original model class metadata used to create this class, or
null if this is not a model class.
|
| getDimensions | | public int getDimensions()(Code) | | |
| getEntityFormat | | Format getEntityFormat()(Code) | | For an entity class or subclass, returns the base entity class; returns
null in other cases.
|
| getEntityMetadata | | EntityMetadata getEntityMetadata()(Code) | | Returns the original model entity metadata used to create this class, or
null if this is not an entity class.
|
| getEvolveNeeded | | boolean getEvolveNeeded()(Code) | | Overridden by ComplexFormat.
|
| getExistingType | | final Class getExistingType()(Code) | | Called to get the type when it is known to exist for an uninitialized
format.
|
| getId | | final int getId()(Code) | | Returns the format ID.
|
| getLatestVersion | | final Format getLatestVersion()(Code) | | If this is the latest/evolved format, returns this; otherwise, returns
the current version of this format. Note that this WILL return a
format for a deleted class if the latest format happens to be deleted.
|
| getPreviousVersion | | final public Format getPreviousVersion()(Code) | | Returns the previous version of this format in the linked list of
versions, or null if this is the only version.
|
| getProxiedFormat | | final Format getProxiedFormat()(Code) | | Returns the format that is proxied by this format. If non-null is
returned, then this format is a PersistentProxy.
|
| getReader | | final Reader getReader()(Code) | | Returns the object for reading objects of the latest format. For the
latest version format, 'this' is returned. For prior version formats, a
reader that converts this version to the latest version is returned.
|
| getSequenceKeyFormat | | Format getSequenceKeyFormat()(Code) | | Validates and returns the simple integer key format for a sequence key
associated with this format.
For a composite key type, the format of the one and only field is
returned. For a simple integer type, this format is returned.
Otherwise (the default implementation), an IllegalArgumentException is
thrown.
|
| getSuperFormat | | final Format getSuperFormat()(Code) | | Returns the format of the superclass.
|
| getType | | final Class getType()(Code) | | Returns the class that this format represents. This method will return
null in rawAccess mode, or for an unevolved format.
|
| getVersion | | public int getVersion()(Code) | | |
| getWrapperFormat | | Format getWrapperFormat()(Code) | | For primitive types only, returns their associated wrapper type.
|
| initialize | | abstract void initialize(Catalog catalog, int initVersion)(Code) | | Initializes an uninitialized format, initializing its related formats
(superclass formats and array component formats) first.
|
| initializeIfNeeded | | final void initializeIfNeeded(Catalog catalog)(Code) | | Called by the Catalog to initialize a format, and may also be called
during initialize() for a related format to ensure that the related
format is initialized. This latter case is allowed to support
bidirectional dependencies. This method will do nothing if the format
is already intialized.
|
| initializeReader | | public void initializeReader(Catalog catalog, int initVersion, Format oldFormat)(Code) | | Called to initialize a separate Reader implementation. This method is
called when no separate Reader exists, and does nothing.
|
| isArray | | public boolean isArray()(Code) | | |
| isAssignableTo | | boolean isAssignableTo(Format format)(Code) | | Called by EntityOutput in rawAccess mode to determine whether an object
type is allowed to be assigned to a given field type.
|
| isCurrentVersion | | final boolean isCurrentVersion()(Code) | | Returns whether this format is the current format for its class. If
false is returned, this format is setup to evolve to the current format.
|
| isDeleted | | final boolean isDeleted()(Code) | | Returns whether the class for this format was deleted.
|
| isEntity | | boolean isEntity()(Code) | | Returns whether this format class is an entity class.
|
| isEnum | | public boolean isEnum()(Code) | | |
| isInitialized | | final boolean isInitialized()(Code) | | |
| isModelClass | | boolean isModelClass()(Code) | | Returns whether this class is present in the EntityModel. Returns false
for a simple type, array type, or enum type.
|
| isNew | | final boolean isNew()(Code) | | |
| isPredefined | | static boolean isPredefined(Format format)(Code) | | |
| isPriKeyNullOrZero | | boolean isPriKeyNullOrZero(Object o, boolean rawAccess)(Code) | | Returns whether the entity's primary key field is null or zero, as
defined for primary keys that are assigned from a sequence.
|
| isPrimitive | | public boolean isPrimitive()(Code) | | |
| isSameClass | | final boolean isSameClass(Format other)(Code) | | Returns whether this format has the same class as the given format,
irrespective of version changes and renaming.
|
| isSimple | | public boolean isSimple()(Code) | | |
| migrateFromBeta | | void migrateFromBeta(Map<String, Format> formatMap)(Code) | | Special handling for JE 3.0.12 beta formats.
|
| newArray | | abstract Object newArray(int len)(Code) | | 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.
|
| newInstance | | abstract public Object newInstance(EntityInput input, boolean rawAccess)(Code) | | 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.
|
| nullifySecKey | | boolean nullifySecKey(Catalog catalog, Object entity, String keyName, Object keyElement)(Code) | | Nullifies the given key field in the given RawObject -- rawAccess mode
is implied.
|
| readObject | | abstract public Object readObject(Object o, EntityInput input, boolean rawAccess)(Code) | | 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.
|
| readPriKey | | public void readPriKey(Object o, EntityInput input, boolean rawAccess)(Code) | | 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.
|
| setDeleted | | final void setDeleted(boolean deleted)(Code) | | Called by the Evolver when applying a Deleter mutation.
|
| setEvolveNeeded | | void setEvolveNeeded(boolean needed)(Code) | | 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.
|
| setId | | final void setId(int id)(Code) | | Called by the Catalog to set the format ID when a new format is added to
the format list, before calling initializeIfNeeded().
|
| setLatestVersion | | final void setLatestVersion(Format newFormat)(Code) | | Called by Evolver to set the latest format when this old format is
evolved.
|
| setProxiedFormat | | final void setProxiedFormat(Format proxiedFormat)(Code) | | Called by ProxiedFormat to set the proxied format.
|
| setReader | | final void setReader(Reader reader)(Code) | | Changes the reader during format evolution.
|
| setSuperFormat | | final void setSuperFormat(Format superFormat)(Code) | | Called to set the format of the superclass during initialize().
|
| setUnused | | final void setUnused(boolean unused)(Code) | | Called by the Evolver for a format that is never referenced.
|
| skipContents | | abstract void skipContents(RecordInput input)(Code) | | 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.
|
| skipToSecKey | | Format skipToSecKey(RecordInput input, String keyName)(Code) | | 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.
|
| writeObject | | abstract void writeObject(Object o, EntityOutput output, boolean rawAccess)(Code) | | Writes a given instance of the target class to the output data bytes.
This is the complement of the newInstance()/readObject() pair.
|
| writePriKey | | void writePriKey(Object o, EntityOutput output, boolean rawAccess)(Code) | | 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.
|
|
|