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
|
/*
* Copyright 2006-2012 Amazon Technologies, Inc. or its affiliates.
* Amazon, Amazon.com and Carbonado are trademarks or registered trademarks
* of Amazon Technologies, Inc. or its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.amazon.carbonado.repo.indexed;
import com.amazon.carbonado.Alias;
import com.amazon.carbonado.Independent;
import com.amazon.carbonado.Nullable;
import com.amazon.carbonado.PrimaryKey;
import com.amazon.carbonado.Storable;
import com.amazon.carbonado.Version;
import com.amazon.carbonado.layout.Unevolvable;
/**
* Stores basic information about the indexes managed by IndexedRepository.
*
* <p>Note: This storable cannot have indexes defined, since it is used to
* discover information about indexes. It would create a cyclic dependency.
*
* @author Brian S O'Neill
*/
@PrimaryKey("indexName")
@Independent
@Alias("CARBONADO_INDEX_INFO")
public interface StoredIndexInfo extends Storable, Unevolvable, Unindexed {
/**
* Returns the index name, which is also a valid index name
* descriptor. This descriptor is defined by {@link
* com.amazon.carbonado.info.StorableIndex}. The name descriptor does not
* contain type information.
*/
String getIndexName();
void setIndexName(String name);
/**
* Returns the types of the index properties. This descriptor is defined by
* {@link com.amazon.carbonado.info.StorableIndex}.
*/
@Nullable
String getIndexTypeDescriptor();
void setIndexTypeDescriptor(String descriptor);
/**
* Returns the milliseconds from 1970-01-01T00:00:00Z when this record was
* created.
*/
long getCreationTimestamp();
void setCreationTimestamp(long timestamp);
/**
* Record version number for this StoredIndexInfo instance. Some encoding
* strategies require a version number.
*/
@Version
int getVersionNumber();
void setVersionNumber(int version);
/**
* Since this record cannot evolve, this property allows it to be extended
* without conflicting with existing records. This record cannot evolve
* because an evolution strategy likely depends on this interface remaining
* stable, avoiding a cyclic dependency.
*/
@Nullable
byte[] getExtraData();
void setExtraData(byte[] data);
}
|
