1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
/*-
* See the file LICENSE for redistribution information.
*
* Copyright (c) 2002, 2015 Oracle and/or its affiliates. All rights reserved.
*
*/
package com.sleepycat.persist.impl;
import java.util.Map;
import com.sleepycat.persist.raw.RawObject;
import java.util.IdentityHashMap;
/**
* Catalog operation interface used by format classes.
*
* @see PersistCatalog
* @see SimpleCatalog
* @see ReadOnlyCatalog
*
* @author Mark Hayes
*/
interface Catalog {
/*
* The catalog version is returned by getInitVersion and is the version of
* the serialized format classes loaded from the stored catalog. When a
* field is added, for example, the version can be checked to determine how
* to initialize the field in Format.initialize.
*
* -1: The version is considered to be -1 when reading the beta version of
* the catalog data. At this point no version field was stored, but we can
* distinguish the beta stored format. See PersistCatalog.
*
* 0: The first released version of the catalog data, after beta. At this
* point no version field was stored, but it is initialized to zero when
* the PersistCatalog.Data object is de-serialized.
*
* 1: Add the ComplexFormat.ConvertFieldReader.oldFieldNum field. [#15797]
*/
static final int BETA_VERSION = -1;
static final int CURRENT_VERSION = 1;
/**
* See above.
*/
int getInitVersion(Format format, boolean forReader);
/**
* Returns a format for a given ID, or throws an exception. This method is
* used when reading an object from the byte array format.
*
* @param expectStored is true if reading a record from a database, and
* therefore the format ID is expected to be stored also. If the format ID
* is not stored, a RefreshException is thrown.
*
* @throws IllegalStateException if the formatId does not correspond to a
* persistent class. This is an internal consistency error.
*/
Format getFormat(int formatId, boolean expectStored)
throws RefreshException;
/**
* Returns a format for a given class, or throws an exception. This method
* is used when writing an object that was passed in by the user.
*
* @param checkEntitySubclassIndexes is true if we're expecting this format
* to be an entity subclass and therefore subclass secondary indexes should
* be opened.
*
* @throws IllegalArgumentException if the class is not persistent. This
* is a user error.
*/
Format getFormat(Class cls, boolean checkEntitySubclassIndexes)
throws RefreshException;
/**
* Returns a format by class name. Unlike {@link #getFormat(Class)}, the
* format will not be created if it is not already known.
*/
Format getFormat(String className);
/**
* @see PersistCatalog#createFormat
*/
Format createFormat(String clsName, Map<String, Format> newFormats);
/**
* @see PersistCatalog#createFormat
*/
Format createFormat(Class type, Map<String, Format> newFormats);
/**
* @see PersistCatalog#isRawAccess
*/
boolean isRawAccess();
/**
* @see PersistCatalog#convertRawObject
*/
Object convertRawObject(RawObject o, IdentityHashMap converted)
throws RefreshException;
/**
* @see PersistCatalog#resolveClass
*/
Class resolveClass(String clsName)
throws ClassNotFoundException;
/**
* @see PersistCatalog#resolveKeyClass
*/
Class resolveKeyClass(String clsName);
}
|
