Class Collection<T extends Document>
- java.lang.Object
-
- org.apache.jackrabbit.oak.plugins.document.Collection<T>
-
- Type Parameters:
T
- the document type
public abstract class Collection<T extends Document> extends java.lang.Object
The collection types.
-
-
Field Summary
Fields Modifier and Type Field Description static Collection<Document>
BLOBS
The 'blobs' collection contains data from the blob store.static Collection<ClusterNodeInfoDocument>
CLUSTER_NODES
The 'clusterNodes' collection contains the list of currently running cluster nodes.static Collection<JournalEntry>
JOURNAL
The 'journal' collection contains documents with consolidated diffs for changes performed by a cluster node between two background updates.static Collection<NodeDocument>
NODES
The 'nodes' collection.static Collection<Document>
SETTINGS
The 'settings' collection contains setting/state data required for DocumentNodeStore
-
Constructor Summary
Constructors Constructor Description Collection(java.lang.String name)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract T
newDocument(DocumentStore store)
java.lang.String
toString()
-
-
-
Field Detail
-
NODES
public static final Collection<NodeDocument> NODES
The 'nodes' collection. It contains all the node data, with one document per node, and the path as the primary key. Each document possibly contains multiple revisions.Key: the path, value: the node data (possibly multiple revisions)
Old revisions are removed after some time, either by the process that removed or updated the node, lazily when reading, or in a background process.
-
CLUSTER_NODES
public static final Collection<ClusterNodeInfoDocument> CLUSTER_NODES
The 'clusterNodes' collection contains the list of currently running cluster nodes. The key is the clusterNodeId (0, 1, 2,...).
-
SETTINGS
public static final Collection<Document> SETTINGS
The 'settings' collection contains setting/state data required for DocumentNodeStore
-
JOURNAL
public static final Collection<JournalEntry> JOURNAL
The 'journal' collection contains documents with consolidated diffs for changes performed by a cluster node between two background updates.
-
BLOBS
public static final Collection<Document> BLOBS
The 'blobs' collection contains data from the blob store. The methodnewDocument(DocumentStore)
always throws anUnsupportedOperationException
because blobs are not stored asDocument
s.
-
-
Method Detail
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
newDocument
@NotNull public abstract T newDocument(DocumentStore store)
- Parameters:
store
- the document store.- Returns:
- a new document for this collection.
-
-