Uses of Class
org.apache.jackrabbit.oak.plugins.document.Document

Packages that use Document

Package	Description
org.apache.jackrabbit.oak.plugins.document
org.apache.jackrabbit.oak.plugins.document.memory
org.apache.jackrabbit.oak.plugins.document.mongo
org.apache.jackrabbit.oak.plugins.document.rdb	Implementations of DocumentStore and BlobStore for relational databases.
org.apache.jackrabbit.oak.plugins.document.util

Uses of Document in org.apache.jackrabbit.oak.plugins.document

Classes in org.apache.jackrabbit.oak.plugins.document with type parameters of type Document

Modifier and Type	Class and Description
class	Collection<T extends Document> The collection types.

Subclasses of Document in org.apache.jackrabbit.oak.plugins.document

Modifier and Type	Class and Description
class	ClusterNodeInfoDocument A document storing cluster node info.
class	JournalEntry Keeps track of changes performed between two consecutive background updates.
class	NodeDocument A document storing data about a node.

Fields in org.apache.jackrabbit.oak.plugins.document with type parameters of type Document

Modifier and Type	Field and Description
static Collection<Document>	Collection.BLOBS The 'blobs' collection contains data from the blob store.
static Collection<Document>	Collection.SETTINGS The 'settings' collection contains setting/state data required for DocumentNodeStore

Methods in org.apache.jackrabbit.oak.plugins.document with type parameters of type Document

Modifier and Type	Method and Description
<T extends Document> boolean	DocumentStore.create(Collection<T> collection, List<UpdateOp> updateOps) Try to create a list of documents.
<T extends Document> List<T>	DocumentStore.createOrUpdate(Collection<T> collection, List<UpdateOp> updateOps) Create or unconditionally update a number of documents.
<T extends Document> T	DocumentStore.createOrUpdate(Collection<T> collection, UpdateOp update) Atomically checks if the document exists and updates it, otherwise the document is created (aka "upsert"), unless the update operation requires the document to be present (see UpdateOp.isNew()).
<T extends Document> T	DocumentStore.find(Collection<T> collection, String key) Get the document with the given key.
<T extends Document> T	DocumentStore.find(Collection<T> collection, String key, int maxCacheAge) Get the document with the key.
<T extends Document> T	DocumentStore.findAndUpdate(Collection<T> collection, UpdateOp update) Performs a conditional update (e.g.
<T extends Document> T	DocumentStore.getIfCached(Collection<T> collection, String key) Fetches the cached document.
<T extends Document> void	DocumentStore.invalidateCache(Collection<T> collection, String key) Invalidate the document cache for the given key.
<T extends Document> @NotNull List<T>	DocumentStore.query(Collection<T> collection, String fromKey, String toKey, int limit) Get a list of documents where the key is greater than a start value and less than an end value.
<T extends Document> @NotNull List<T>	DocumentStore.query(Collection<T> collection, String fromKey, String toKey, String indexedProperty, long startValue, int limit) Get a list of documents where the key is greater than a start value and less than an end value and the given "indexed property" is greater or equals the specified value.
<T extends Document> void	DocumentStore.remove(Collection<T> collection, List<String> keys) Batch remove documents with given keys.
<T extends Document> int	DocumentStore.remove(Collection<T> collection, Map<String,Long> toRemove) Batch remove documents with given keys and corresponding equal conditions on NodeDocument.MODIFIED_IN_SECS values.
<T extends Document> void	DocumentStore.remove(Collection<T> collection, String key) Remove a document.
<T extends Document> int	DocumentStore.remove(Collection<T> collection, String indexedProperty, long startValue, long endValue) Batch remove documents where the given "indexed property" is within the given range (exclusive) - (startValue, endValue).

Methods in org.apache.jackrabbit.oak.plugins.document with parameters of type Document

Modifier and Type	Method and Description
static void	UpdateUtils.applyChanges(@NotNull Document doc, @NotNull UpdateOp update) Apply the changes to the in-memory document.
static boolean	UpdateUtils.checkConditions(@NotNull Document doc, @NotNull Map<UpdateOp.Key,UpdateOp.Condition> conditions)
void	Document.deepCopy(Document target) Performs a deep copy of the data within this document to the given target.

Method parameters in org.apache.jackrabbit.oak.plugins.document with type arguments of type Document

Modifier and Type	Method and Description
void	DocumentStoreStats.doneCreate(long timeTakenNanos, Collection<? extends Document> collection, List<String> ids, boolean insertSuccess)
void	DocumentStoreStatsCollector.doneCreate(long timeTakenNanos, Collection<? extends Document> collection, List<String> ids, boolean insertSuccess) Called when a document is created in the given collection
void	DocumentStoreStats.doneCreateOrUpdate(long timeTakenNanos, Collection<? extends Document> collection, List<String> ids)
void	DocumentStoreStatsCollector.doneCreateOrUpdate(long timeTakenNanos, Collection<? extends Document> collection, List<String> ids) Called when multiple document are either created or updated.
void	DocumentStoreStats.doneFindAndModify(long timeTakenNanos, Collection<? extends Document> collection, String key, boolean newEntry, boolean success, int retryCount)
void	DocumentStoreStatsCollector.doneFindAndModify(long timeTakenNanos, Collection<? extends Document> collection, String key, boolean newEntry, boolean success, int retryCount) Called when a update operation was completed which affected single document.
void	DocumentStoreStats.doneFindCached(Collection<? extends Document> collection, String key)
void	DocumentStoreStatsCollector.doneFindCached(Collection<? extends Document> collection, String key) Called when a document with given key is found from the cache
void	DocumentStoreStats.doneFindUncached(long timeTakenNanos, Collection<? extends Document> collection, String key, boolean docFound, boolean isSlaveOk)
void	DocumentStoreStatsCollector.doneFindUncached(long timeTakenNanos, Collection<? extends Document> collection, String key, boolean docFound, boolean isSlaveOk) Called when a document with given key is read from remote store
void	DocumentStoreStats.doneQuery(long timeTakenNanos, Collection<? extends Document> collection, String fromKey, String toKey, boolean indexedProperty, int resultSize, long lockTime, boolean isSlaveOk)
void	DocumentStoreStatsCollector.doneQuery(long timeTakenNanos, Collection<? extends Document> collection, String fromKey, String toKey, boolean indexedProperty, int resultSize, long lockTime, boolean isSlaveOk) Called when query with given parameters is performed
void	DocumentStoreStats.doneRemove(long timeTakenNanos, Collection<? extends Document> collection, int removeCount)
void	DocumentStoreStatsCollector.doneRemove(long timeTakenNanos, Collection<? extends Document> collection, int removeCount) Called when a remove operation for documents was completed.

Uses of Document in org.apache.jackrabbit.oak.plugins.document.memory

Methods in org.apache.jackrabbit.oak.plugins.document.memory with type parameters of type Document

Modifier and Type	Method and Description
<T extends Document> boolean	MemoryDocumentStore.create(Collection<T> collection, List<UpdateOp> updateOps)
<T extends Document> List<T>	MemoryDocumentStore.createOrUpdate(Collection<T> collection, List<UpdateOp> updateOps)
<T extends Document> T	MemoryDocumentStore.createOrUpdate(Collection<T> collection, UpdateOp update)
<T extends Document> T	MemoryDocumentStore.find(Collection<T> collection, String key)
<T extends Document> T	MemoryDocumentStore.find(Collection<T> collection, String key, int maxCacheAge)
<T extends Document> T	MemoryDocumentStore.findAndUpdate(Collection<T> collection, UpdateOp update)
<T extends Document> T	MemoryDocumentStore.getIfCached(Collection<T> collection, String key)
protected <T extends Document> ConcurrentSkipListMap<String,T>	MemoryDocumentStore.getMap(Collection<T> collection) Get the in-memory map for this collection.
<T extends Document> void	MemoryDocumentStore.invalidateCache(Collection<T> collection, String key)
<T extends Document> @NotNull List<T>	MemoryDocumentStore.query(Collection<T> collection, String fromKey, String toKey, int limit)
<T extends Document> @NotNull List<T>	MemoryDocumentStore.query(Collection<T> collection, String fromKey, String toKey, String indexedProperty, long startValue, int limit)
<T extends Document> void	MemoryDocumentStore.remove(Collection<T> collection, List<String> keys)
<T extends Document> int	MemoryDocumentStore.remove(Collection<T> collection, Map<String,Long> toRemove)
<T extends Document> void	MemoryDocumentStore.remove(Collection<T> collection, String key)
<T extends Document> int	MemoryDocumentStore.remove(Collection<T> collection, String indexedProperty, long startValue, long endValue)

Uses of Document in org.apache.jackrabbit.oak.plugins.document.mongo

Methods in org.apache.jackrabbit.oak.plugins.document.mongo with type parameters of type Document

Modifier and Type	Method and Description
protected <T extends Document> T	MongoDocumentStore.convertFromDBObject(@NotNull Collection<T> collection, @Nullable com.mongodb.DBObject n)
<T extends Document> boolean	MongoDocumentStore.create(Collection<T> collection, List<UpdateOp> updateOps)
<T extends Document> @Nullable List<T>	MongoDocumentStore.createOrUpdate(Collection<T> collection, List<UpdateOp> updateOps) Try to apply all the UpdateOps with at least MongoDB requests as possible.
<T extends Document> T	MongoDocumentStore.createOrUpdate(Collection<T> collection, UpdateOp update)
<T extends Document> T	MongoDocumentStore.find(Collection<T> collection, String key)
<T extends Document> T	MongoDocumentStore.find(Collection<T> collection, String key, int maxCacheAge)
<T extends Document> T	MongoDocumentStore.findAndUpdate(Collection<T> collection, UpdateOp update)
protected <T extends Document> T	MongoDocumentStore.findUncached(Collection<T> collection, String key, org.apache.jackrabbit.oak.plugins.document.mongo.MongoDocumentStore.DocumentReadPreference docReadPref)
<T extends Document> T	MongoDocumentStore.getIfCached(Collection<T> collection, String key)
<T extends Document> void	MongoDocumentStore.invalidateCache(Collection<T> collection, String key)
<T extends Document> @NotNull List<T>	MongoDocumentStore.query(Collection<T> collection, String fromKey, String toKey, int limit)
<T extends Document> @NotNull List<T>	MongoDocumentStore.query(Collection<T> collection, String fromKey, String toKey, String indexedProperty, long startValue, int limit)
protected <T extends Document> @NotNull List<T>	MongoDocumentStore.queryInternal(Collection<T> collection, String fromKey, String toKey, String indexedProperty, long startValue, int limit, long maxQueryTime)
<T extends Document> void	MongoDocumentStore.remove(Collection<T> collection, List<String> keys)
<T extends Document> int	MongoDocumentStore.remove(Collection<T> collection, Map<String,Long> toRemove)
<T extends Document> void	MongoDocumentStore.remove(Collection<T> collection, String key)
<T extends Document> int	MongoDocumentStore.remove(Collection<T> collection, String indexedProperty, long startValue, long endValue)

Uses of Document in org.apache.jackrabbit.oak.plugins.document.rdb

Methods in org.apache.jackrabbit.oak.plugins.document.rdb with type parameters of type Document

Modifier and Type	Method and Description
protected <T extends Document> T	RDBDocumentStore.convertFromDBObject(@NotNull Collection<T> collection, @NotNull RDBRow row)
<T extends Document> boolean	RDBDocumentStore.create(Collection<T> collection, List<UpdateOp> updateOps)
<T extends Document> List<T>	RDBDocumentStore.createOrUpdate(Collection<T> collection, List<UpdateOp> updateOps)
<T extends Document> T	RDBDocumentStore.createOrUpdate(Collection<T> collection, UpdateOp update)
<T extends Document> T	RDBDocumentStore.find(Collection<T> collection, String id)
<T extends Document> T	RDBDocumentStore.find(Collection<T> collection, String id, int maxCacheAge)
<T extends Document> T	RDBDocumentStore.findAndUpdate(Collection<T> collection, UpdateOp update)
<T extends Document> T	RDBDocumentSerializer.fromRow(@NotNull Collection<T> collection, @NotNull RDBRow row) Reconstructs a Document based on the persisted RDBRow.
<T extends Document> T	RDBDocumentStore.getIfCached(Collection<T> collection, String id)
protected <T extends Document> long	RDBDocumentStore.getMinValue(Collection<T> collection, String field, String fromKey, String toKey, List<String> excludeKeyPatterns, List<RDBDocumentStore.QueryCondition> conditions)
protected <T extends Document> @NotNull org.apache.jackrabbit.oak.plugins.document.rdb.RDBDocumentStore.RDBTableMetaData	RDBDocumentStore.getTable(Collection<T> collection)
<T extends Document> Set<String>	RDBDocumentStoreJDBC.insert(Connection connection, org.apache.jackrabbit.oak.plugins.document.rdb.RDBDocumentStore.RDBTableMetaData tmd, List<T> documents)
<T extends Document> void	RDBDocumentStore.invalidateCache(Collection<T> collection, String id)
<T extends Document> @NotNull List<T>	RDBDocumentStore.query(Collection<T> collection, String fromKey, String toKey, int limit)
protected <T extends Document> @NotNull List<T>	RDBDocumentStore.query(Collection<T> collection, String fromKey, String toKey, List<String> excludeKeyPatterns, List<RDBDocumentStore.QueryCondition> conditions, int limit)
<T extends Document> @NotNull List<T>	RDBDocumentStore.query(Collection<T> collection, String fromKey, String toKey, String indexedProperty, long startValue, int limit)
protected <T extends Document> Iterable<T>	RDBDocumentStore.queryAsIterable(Collection<T> collection, String fromKey, String toKey, List<String> excludeKeyPatterns, List<RDBDocumentStore.QueryCondition> conditions, int limit, String sortBy)
protected <T extends Document> long	RDBDocumentStore.queryCount(Collection<T> collection, String fromKey, String toKey, List<String> excludeKeyPatterns, List<RDBDocumentStore.QueryCondition> conditions)
<T extends Document> void	RDBDocumentStore.remove(Collection<T> collection, List<String> ids)
<T extends Document> int	RDBDocumentStore.remove(Collection<T> collection, Map<String,Long> toRemove)
<T extends Document> void	RDBDocumentStore.remove(Collection<T> collection, String id)
<T extends Document> int	RDBDocumentStore.remove(Collection<T> collection, String indexedProperty, long startValue, long endValue)
<T extends Document> Set<String>	RDBDocumentStoreJDBC.update(Connection connection, org.apache.jackrabbit.oak.plugins.document.rdb.RDBDocumentStore.RDBTableMetaData tmd, List<T> documents, boolean upsert) Update a list of documents using JDBC batches.

Methods in org.apache.jackrabbit.oak.plugins.document.rdb with parameters of type Document

Modifier and Type	Method and Description
String	RDBDocumentSerializer.asString(@NotNull Document doc, Set<String> columnProperties) Serializes all non-column properties of the Document into a JSON string.

Uses of Document in org.apache.jackrabbit.oak.plugins.document.util

Methods in org.apache.jackrabbit.oak.plugins.document.util with type parameters of type Document

Modifier and Type	Method and Description
<T extends Document> boolean	LoggingDocumentStoreWrapper.create(Collection<T> collection, List<UpdateOp> updateOps)
<T extends Document> boolean	TimingDocumentStoreWrapper.create(Collection<T> collection, List<UpdateOp> updateOps)
<T extends Document> boolean	LeaseCheckDocumentStoreWrapper.create(Collection<T> collection, List<UpdateOp> updateOps)
<T extends Document> boolean	SynchronizingDocumentStoreWrapper.create(Collection<T> collection, List<UpdateOp> updateOps)
<T extends Document> List<T>	LoggingDocumentStoreWrapper.createOrUpdate(Collection<T> collection, List<UpdateOp> updateOps)
<T extends Document> List<T>	TimingDocumentStoreWrapper.createOrUpdate(Collection<T> collection, List<UpdateOp> updateOps)
<T extends Document> List<T>	LeaseCheckDocumentStoreWrapper.createOrUpdate(Collection<T> collection, List<UpdateOp> updateOps)
<T extends Document> List<T>	SynchronizingDocumentStoreWrapper.createOrUpdate(Collection<T> collection, List<UpdateOp> updateOps)
<T extends Document> T	LoggingDocumentStoreWrapper.createOrUpdate(Collection<T> collection, UpdateOp update)
<T extends Document> T	TimingDocumentStoreWrapper.createOrUpdate(Collection<T> collection, UpdateOp update)
<T extends Document> T	LeaseCheckDocumentStoreWrapper.createOrUpdate(Collection<T> collection, UpdateOp update)
<T extends Document> T	SynchronizingDocumentStoreWrapper.createOrUpdate(Collection<T> collection, UpdateOp update)
<T extends Document> T	LoggingDocumentStoreWrapper.find(Collection<T> collection, String key)
<T extends Document> T	TimingDocumentStoreWrapper.find(Collection<T> collection, String key)
<T extends Document> T	LeaseCheckDocumentStoreWrapper.find(Collection<T> collection, String key)
<T extends Document> T	SynchronizingDocumentStoreWrapper.find(Collection<T> collection, String key)
<T extends Document> T	LoggingDocumentStoreWrapper.find(Collection<T> collection, String key, int maxCacheAge)
<T extends Document> T	TimingDocumentStoreWrapper.find(Collection<T> collection, String key, int maxCacheAge)
<T extends Document> T	LeaseCheckDocumentStoreWrapper.find(Collection<T> collection, String key, int maxCacheAge)
<T extends Document> T	SynchronizingDocumentStoreWrapper.find(Collection<T> collection, String key, int maxCacheAge)
<T extends Document> T	LoggingDocumentStoreWrapper.findAndUpdate(Collection<T> collection, UpdateOp update)
<T extends Document> T	TimingDocumentStoreWrapper.findAndUpdate(Collection<T> collection, UpdateOp update)
<T extends Document> T	LeaseCheckDocumentStoreWrapper.findAndUpdate(Collection<T> collection, UpdateOp update)
<T extends Document> T	SynchronizingDocumentStoreWrapper.findAndUpdate(Collection<T> collection, UpdateOp update)
<T extends Document> T	LoggingDocumentStoreWrapper.getIfCached(Collection<T> collection, String key)
<T extends Document> T	TimingDocumentStoreWrapper.getIfCached(Collection<T> collection, String key)
<T extends Document> T	LeaseCheckDocumentStoreWrapper.getIfCached(Collection<T> collection, String key)
<T extends Document> T	SynchronizingDocumentStoreWrapper.getIfCached(Collection<T> collection, String key)
<T extends Document> void	LoggingDocumentStoreWrapper.invalidateCache(Collection<T> collection, String key)
<T extends Document> void	TimingDocumentStoreWrapper.invalidateCache(Collection<T> collection, String key)
<T extends Document> void	LeaseCheckDocumentStoreWrapper.invalidateCache(Collection<T> collection, String key)
<T extends Document> void	SynchronizingDocumentStoreWrapper.invalidateCache(Collection<T> collection, String key)
<T extends Document> @NotNull List<T>	LoggingDocumentStoreWrapper.query(Collection<T> collection, String fromKey, String toKey, int limit)
<T extends Document> @NotNull List<T>	TimingDocumentStoreWrapper.query(Collection<T> collection, String fromKey, String toKey, int limit)
<T extends Document> List<T>	LeaseCheckDocumentStoreWrapper.query(Collection<T> collection, String fromKey, String toKey, int limit)
<T extends Document> @NotNull List<T>	SynchronizingDocumentStoreWrapper.query(Collection<T> collection, String fromKey, String toKey, int limit)
<T extends Document> @NotNull List<T>	LoggingDocumentStoreWrapper.query(Collection<T> collection, String fromKey, String toKey, String indexedProperty, long startValue, int limit)
<T extends Document> @NotNull List<T>	TimingDocumentStoreWrapper.query(Collection<T> collection, String fromKey, String toKey, String indexedProperty, long startValue, int limit)
<T extends Document> List<T>	LeaseCheckDocumentStoreWrapper.query(Collection<T> collection, String fromKey, String toKey, String indexedProperty, long startValue, int limit)
<T extends Document> @NotNull List<T>	SynchronizingDocumentStoreWrapper.query(Collection<T> collection, String fromKey, String toKey, String indexedProperty, long startValue, int limit)
<T extends Document> void	LoggingDocumentStoreWrapper.remove(Collection<T> collection, List<String> keys)
<T extends Document> void	TimingDocumentStoreWrapper.remove(Collection<T> collection, List<String> keys)
<T extends Document> void	LeaseCheckDocumentStoreWrapper.remove(Collection<T> collection, List<String> keys)
<T extends Document> void	SynchronizingDocumentStoreWrapper.remove(Collection<T> collection, List<String> keys)
<T extends Document> int	LoggingDocumentStoreWrapper.remove(Collection<T> collection, Map<String,Long> toRemove)
<T extends Document> int	TimingDocumentStoreWrapper.remove(Collection<T> collection, Map<String,Long> toRemove)
<T extends Document> int	LeaseCheckDocumentStoreWrapper.remove(Collection<T> collection, Map<String,Long> toRemove)
<T extends Document> int	SynchronizingDocumentStoreWrapper.remove(Collection<T> collection, Map<String,Long> toRemove)
<T extends Document> void	LoggingDocumentStoreWrapper.remove(Collection<T> collection, String key)
<T extends Document> void	TimingDocumentStoreWrapper.remove(Collection<T> collection, String key)
<T extends Document> void	LeaseCheckDocumentStoreWrapper.remove(Collection<T> collection, String key)
<T extends Document> void	SynchronizingDocumentStoreWrapper.remove(Collection<T> collection, String key)
<T extends Document> int	LoggingDocumentStoreWrapper.remove(Collection<T> collection, String indexedProperty, long startValue, long endValue)
<T extends Document> int	TimingDocumentStoreWrapper.remove(Collection<T> collection, String indexedProperty, long startValue, long endValue)
<T extends Document> int	LeaseCheckDocumentStoreWrapper.remove(Collection<T> collection, String indexedProperty, long startValue, long endValue)
<T extends Document> int	SynchronizingDocumentStoreWrapper.remove(Collection<T> collection, String indexedProperty, long startValue, long endValue)