Lines Matching defs:format
29 * The design documentation below describes the storage format for entities and
30 * its relationship to information stored per format in the catalog.
48 * Every distinct class format is given a unique format ID. Class IDs are not
50 * and @Persistent) because the format can change when the version number does
51 * not. Changes that cause a unique format ID to be assigned are:
62 * For each distinct class format the following information is conceptually
63 * stored in the catalog, keyed by format ID.
67 * - Superclass format
78 * - Component class format
95 * The formatId is the (positive non-zero) ID of a class format, defined above.
99 * Following the format ID, zero or more sets of secondary key field values
149 * format:
169 * operation directly on the byte format.
174 * of the byte format and can be quickly read.
180 * serialized format directly, adjusting references to key objects, etc. Plus,
189 * Other formats are managed by PersistCatalog. The lifecycle of a format
192 * - Constructed by the catalog when a format is requested for a Class
193 * that currently has no associated format.
195 * - The catalog calls setId() and adds the format to its format list
196 * (indexed by format id) and map (keyed by class name).
198 * - The catalog calls collectRelatedFormats(), where a format can create
202 * method of the format class.
204 * - initialize() should initialize any transient fields in the format.
207 * it needs to interact with an initialized related format; this does not
209 * initialized format.
216 * a format is deserialized, its initializeIfNeeded() method is called.
221 * mode. In raw mode, the old format is used regardless of whether it
225 * - In normal mode, for each existing format that is initialized, a new format
227 * the two formats are equal, the new format is discarded. If they are
228 * unequal, the new format becomes the current format and the old format's
230 * old format for class evolution. Any number of non-current formats may
231 * exist for a given class, and are setup to evolve the single current format
286 static boolean isPredefined(Format format) {
287 return format.getId() <= ID_PREDEFINED;
305 * Creates a new format for a given class.
314 * Creates a format for class evolution when no class may be present.
340 * Returns the format ID.
347 * Called by the Catalog to set the format ID when a new format is added to
348 * the format list, before calling initializeIfNeeded().
355 * Returns the class that this format represents. This method will return
356 * null in rawAccess mode, or for an unevolved format.
364 * format.
378 * Returns the object for reading objects of the latest format. For the
379 * latest version format, 'this' is returned. For prior version formats, a
396 * Changes the reader during format evolution.
403 * Returns the format of the superclass.
410 * Called to set the format of the superclass during initialize().
417 * Returns the format that is proxied by this format. If non-null is
418 * returned, then this format is a PersistentProxy.
425 * Called by ProxiedFormat to set the proxied format.
432 * If this is the latest/evolved format, returns this; otherwise, returns
433 * the current version of this format. Note that this WILL return a
434 * format for a deleted class if the latest format happens to be deleted.
441 * Returns the previous version of this format in the linked list of
449 * Called by Evolver to set the latest format when this old format is
455 * If this old format is the former latest version, link it to the new
467 * Returns whether the class for this format was deleted.
481 * Called by the Evolver for a format that is never referenced.
488 * Called by the Evolver with true when an entity format or any of its
489 * nested format were changed. Called by Store.evolve when an entity has
508 * Called by the Catalog to initialize a format, and may also be called
509 * during initialize() for a related format to ensure that the related
510 * format is initialized. This latter case is allowed to support
511 * bidirectional dependencies. This method will do nothing if the format
529 * mode, for the current version of the format.
650 boolean isAssignableTo(Format format) {
652 return proxiedFormat.isAssignableTo(format);
654 return format == this ||
655 format.id == ID_OBJECT ||
656 supertypes.contains(format.className);
668 * Returns whether this format class is an entity class.
707 * Called for an existing format that may not equal the current format for
713 * then it must have determined that the old format could not be evolved to
714 * the new format, and it must have called Evolver.addInvalidMutation,
730 * Returns whether this format is the current format for its class. If
731 * false is returned, this format is setup to evolve to the current format.
738 * Returns whether this format has the same class as the given format,
748 * Initializes an uninitialized format, initializing its related formats
754 * Calls catalog.createFormat for formats that this format depends on, or
769 * format classes. The second group have default implementations that
774 * Creates an array of the format's class of the given length, as if
799 * during conversion of an old format. Normally it should be called via
811 * during conversion of an old format. Normally it should be called via
828 * format ID is read just before calling this method, so this method is
829 * responsible for skipping everything following the format ID.
837 * the given secondary key field. Returns the format of the key field
895 * during conversion of an old format. Normally it should be called via
903 * Validates and returns the simple integer key format for a sequence key
904 * associated with this format.
906 * For a composite key type, the format of the one and only field is
907 * returned. For a simple integer type, this format is returned.