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

Packages that use NodeDocument

Package	Description
org.apache.jackrabbit.oak.index.indexer.document
org.apache.jackrabbit.oak.index.indexer.document.flatfile.pipelined
org.apache.jackrabbit.oak.plugins.document
org.apache.jackrabbit.oak.plugins.document.cache
org.apache.jackrabbit.oak.plugins.document.check
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 NodeDocument in org.apache.jackrabbit.oak.index.indexer.document

Methods in org.apache.jackrabbit.oak.index.indexer.document with parameters of type NodeDocument

Modifier and Type	Method	Description
boolean	CompositeIndexer.shouldInclude(NodeDocument doc)
boolean	LuceneIndexer.shouldInclude(NodeDocument doc)
boolean	NodeStateIndexer.shouldInclude(NodeDocument doc)

Uses of NodeDocument in org.apache.jackrabbit.oak.index.indexer.document.flatfile.pipelined

Methods in org.apache.jackrabbit.oak.index.indexer.document.flatfile.pipelined that return NodeDocument

Modifier and Type	Method	Description
NodeDocument	NodeDocumentCodec.decode(org.bson.BsonReader reader, org.bson.codecs.DecoderContext decoderContext)

Methods in org.apache.jackrabbit.oak.index.indexer.document.flatfile.pipelined that return types with arguments of type NodeDocument

Modifier and Type	Method	Description
Class<NodeDocument>	NodeDocumentCodec.getEncoderClass()

Methods in org.apache.jackrabbit.oak.index.indexer.document.flatfile.pipelined with parameters of type NodeDocument

Modifier and Type	Method	Description
void	NodeDocumentCodec.encode(org.bson.BsonWriter writer, NodeDocument value, org.bson.codecs.EncoderContext encoderContext)

Constructor parameters in org.apache.jackrabbit.oak.index.indexer.document.flatfile.pipelined with type arguments of type NodeDocument

Modifier	Constructor	Description
	NodeDocumentCodec(MongoDocumentStore store, Collection<NodeDocument> collection, MongoDocumentFilter documentFilter, org.bson.codecs.configuration.CodecRegistry defaultRegistry)

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

Fields in org.apache.jackrabbit.oak.plugins.document declared as NodeDocument

Modifier and Type	Field	Description
static final NodeDocument	NodeDocument.NULL	Marker document, which indicates the document does not exist.

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

Modifier and Type	Field	Description
static final Collection<NodeDocument>	Collection.NODES	The 'nodes' collection.
protected final Iterable<NodeDocument>	SplitDocumentCleanUp.splitDocGarbage

Methods in org.apache.jackrabbit.oak.plugins.document that return NodeDocument

Modifier and Type	Method	Description
static NodeDocument	NodeDocument.fromString(DocumentStore store, String s)
NodeDocument	MissingLastRevSeeker.getRoot()

Methods in org.apache.jackrabbit.oak.plugins.document that return types with arguments of type NodeDocument

Modifier and Type	Method	Description
org.apache.jackrabbit.guava.common.cache.Cache<CacheValue,NodeDocument>	DocumentNodeStoreBuilder.buildDocumentCache(DocumentStore docStore)
org.apache.jackrabbit.guava.common.cache.Cache<StringValue,NodeDocument>	DocumentNodeStoreBuilder.buildPrevDocumentsCache(DocumentStore docStore)
List<NodeDocument>	FullGcNodeBin.findAndUpdate(List<UpdateOp> updateOpList)	Performs a conditional update If the bin is enabled, the removed properties are saved to the SETTINGS collection with ID prefixed with '/bin/' and empty value If the document ID and properties cannot be saved then the removal of the property fails If bin is disabled, the removed properties are directly removed from the NODES collection
@NotNull Iterable<NodeDocument>	MissingLastRevSeeker.getCandidates(long startTime)	Get the candidates with modified time greater than or equal the specified startTime in milliseconds since the start of the epoch.
Optional<NodeDocument>	VersionGCSupport.getDocument(String id, List<String> fields)	Retrieves a document with the given id from the DocumentStore.
Iterator<NodeDocument>	BlobReferenceIterator.getIteratorOverDocsWithBinaries()	Override this document to use a document store specific iterator.
Iterable<NodeDocument>	VersionGCSupport.getModifiedDocs(long fromModified, long toModified, int limit, @NotNull String fromId, @NotNull Set<String> includePaths, @NotNull Set<String> excludePaths)	Returns documents that have a MODIFIED_IN_SECS value within the given range and are greater than given @Document.ID.
Optional<NodeDocument>	VersionGCSupport.getOldestModifiedDoc(Clock clock)	Retrieve the oldest modified document.
Iterable<NodeDocument>	VersionGCSupport.getPossiblyDeletedDocs(long fromModified, long toModified)	Returns documents that have a MODIFIED_IN_SECS value within the given range and the DELETED set to true.
protected Iterable<NodeDocument>	VersionGCSupport.identifyGarbage(Set<NodeDocument.SplitDocType> gcTypes, RevisionVector sweepRevs, long oldestRevTimeStamp)

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

Modifier and Type	Method	Description
void	BlobCollector.collect(NodeDocument doc, Collection<ReferencedBlob> blobs)
void	VersionGarbageCollector.collectGarbageOnDocument(DocumentNodeStore store, NodeDocument doc, boolean verbose)
String	DocumentNodeStore.getCommitValue(@NotNull Revision changeRevision, @NotNull NodeDocument doc)
@Nullable String	RevisionContext.getCommitValue(@NotNull Revision changeRevision, @NotNull NodeDocument doc)	Retrieves the commit value for a given change.
String	RevisionContextWrapper.getCommitValue(@NotNull Revision revision, @NotNull NodeDocument nodeDocument)
static @NotNull SortedMap<Revision,String>	NodeDocumentHelper.getLocalCommitRoot(NodeDocument doc)
static @NotNull SortedMap<Revision,String>	NodeDocumentHelper.getLocalMap(NodeDocument doc, String key)
protected static boolean	VersionGCSupport.isDefaultNoBranchSplitNewerThan(NodeDocument doc, RevisionVector sweepRevs)	Returns true if the given document is of type NodeDocument.SplitDocType.DEFAULT_NO_BRANCH and the most recent change on the document is newer than the sweepRevs.
String	CommitValueResolver.resolve(@NotNull Revision changeRevision, @NotNull NodeDocument doc)	Resolve a change revision on the given document and return the commit value for the change revision.

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

Modifier and Type	Method	Description
int	LastRevRecoveryAgent.recover(Iterable<NodeDocument> suspects, int clusterId)	Same as LastRevRecoveryAgent.recover(Iterable, int, boolean) with dryRun set to false.
int	LastRevRecoveryAgent.recover(Iterable<NodeDocument> suspects, int clusterId, boolean dryRun)	Recover the correct _lastRev updates for the given candidate nodes.

Constructors in org.apache.jackrabbit.oak.plugins.document with parameters of type NodeDocument

Modifier	Constructor	Description
	Consistency(@NotNull DocumentNodeState root, @NotNull NodeDocument document)	Creates a new consistency check for the given NodeDocument.
	NodeDocumentRevisionCleaner(DocumentNodeStore documentNodeStore, NodeDocument workingDocument)	Constructor for NodeDocumentRevisionCleaner.
	NodeDocumentRevisionCleaner(DocumentNodeStore documentNodeStore, NodeDocument workingDocument, long toModifiedMs)	Constructor for NodeDocumentRevisionCleaner.

Constructor parameters in org.apache.jackrabbit.oak.plugins.document with type arguments of type NodeDocument

Modifier	Constructor	Description
protected	SplitDocumentCleanUp(DocumentStore store, VersionGarbageCollector.VersionGCStats stats, Iterable<NodeDocument> splitDocGarbage)

Uses of NodeDocument in org.apache.jackrabbit.oak.plugins.document.cache

Methods in org.apache.jackrabbit.oak.plugins.document.cache that return NodeDocument

Modifier and Type	Method	Description
@NotNull NodeDocument	NodeDocumentCache.get(@NotNull String key, @NotNull Callable<NodeDocument> valueLoader)	Return the document matching given key, optionally loading it from an external source.
@Nullable NodeDocument	NodeDocumentCache.getIfPresent(@NotNull String key)	Return the cached value or null.
@NotNull NodeDocument	NodeDocumentCache.putIfAbsent(@NotNull NodeDocument doc)	Puts document into cache iff no entry with the given key is cached already.
@NotNull NodeDocument	NodeDocumentCache.putIfNewer(@NotNull NodeDocument doc)	Puts document into cache iff no entry with the given key is cached already or the cached document is older (has smaller Document.MOD_COUNT).

Methods in org.apache.jackrabbit.oak.plugins.document.cache that return types with arguments of type NodeDocument

Modifier and Type	Method	Description
Iterable<NodeDocument>	NodeDocumentCache.values()

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

Modifier and Type	Method	Description
void	NodeDocumentCache.put(@NotNull NodeDocument doc)	Puts document into cache.
@NotNull NodeDocument	NodeDocumentCache.putIfAbsent(@NotNull NodeDocument doc)	Puts document into cache iff no entry with the given key is cached already.
@NotNull NodeDocument	NodeDocumentCache.putIfNewer(@NotNull NodeDocument doc)	Puts document into cache iff no entry with the given key is cached already or the cached document is older (has smaller Document.MOD_COUNT).
protected final void	NodeDocumentCache.putInternal(@NotNull NodeDocument doc)	Puts a document into the cache without acquiring a lock.
protected final void	NodeDocumentCache.putInternal(@NotNull NodeDocument doc, @Nullable CacheChangesTracker trackerToSkip)	Puts a document into the cache without acquiring a lock.
void	NodeDocumentCache.replaceCachedDocument(@NotNull NodeDocument oldDoc, @NotNull NodeDocument newDoc)	Replaces the cached value if the old document is currently present in the cache.

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

Modifier and Type	Method	Description
@NotNull NodeDocument	NodeDocumentCache.get(@NotNull String key, @NotNull Callable<NodeDocument> valueLoader)	Return the document matching given key, optionally loading it from an external source.
void	NodeDocumentCache.putNonConflictingDocs(CacheChangesTracker tracker, Iterable<NodeDocument> docs)	Updates the cache with all the documents that: (1) currently have their older versions in the cache or (2) have been neither put nor invalidated during the tracker lifetime.

Constructor parameters in org.apache.jackrabbit.oak.plugins.document.cache with type arguments of type NodeDocument

Modifier	Constructor	Description
	NodeDocumentCache(@NotNull org.apache.jackrabbit.guava.common.cache.Cache<CacheValue,NodeDocument> nodeDocumentsCache, @NotNull CacheStats nodeDocumentsCacheStats, @NotNull org.apache.jackrabbit.guava.common.cache.Cache<StringValue,NodeDocument> prevDocumentsCache, @NotNull CacheStats prevDocumentsCacheStats, @NotNull NodeDocumentLocks locks)

Uses of NodeDocument in org.apache.jackrabbit.oak.plugins.document.check

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

Modifier and Type	Method	Description
protected abstract Optional<Callable<Void>>	AsyncDocumentProcessor.createTask(@NotNull NodeDocument document, @NotNull BlockingQueue<Result> results)
protected final Optional<Callable<Void>>	AsyncNodeStateProcessor.createTask(@NotNull NodeDocument document, @NotNull BlockingQueue<Result> results)
protected Optional<Callable<Void>>	ConsistencyCheck.createTask(@NotNull NodeDocument document, @NotNull BlockingQueue<Result> results)
protected Optional<Callable<Void>>	OrphanedNodeCheck.createTask(@NotNull NodeDocument document, @NotNull BlockingQueue<Result> results)
protected boolean	AsyncNodeStateProcessor.process(NodeDocument doc)	Decide early whether a NodeDocument should be processed or not.
final void	AsyncDocumentProcessor.processDocument(@NotNull NodeDocument document, @NotNull BlockingQueue<Result> results)
void	CompositeDocumentProcessor.processDocument(@NotNull NodeDocument document, @NotNull BlockingQueue<Result> results)
void	DocumentProcessor.processDocument(@NotNull NodeDocument document, @NotNull BlockingQueue<Result> results)	Process the given document and publish the result to the results queue.
void	Progress.processDocument(@NotNull NodeDocument document, @NotNull BlockingQueue<Result> results)
void	Summary.processDocument(@NotNull NodeDocument document, @NotNull BlockingQueue<Result> results)

Constructors in org.apache.jackrabbit.oak.plugins.document.check with parameters of type NodeDocument

Modifier	Constructor	Description
	NodeStateTask(@NotNull NodeDocument document, @NotNull BlockingQueue<Result> results)

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

Methods in org.apache.jackrabbit.oak.plugins.document.mongo that return types with arguments of type NodeDocument

Modifier and Type	Method	Description
List<NodeDocument>	MongoFullGcNodeBin.findAndUpdate(List<UpdateOp> updateOpList)	Performs a conditional update If the bin is enabled, the removed properties are saved to the BIN collection with ID prefixed with '/bin/' and empty value If the document ID and properties cannot be saved then the removal of the property fails If bin is disabled, the removed properties are directly removed from the NODES collection
static Iterable<NodeDocument>	MongoDocumentStoreCheckHelper.getAllNodeDocuments(MongoDocumentStore store)
@NotNull CloseableIterable<NodeDocument>	MongoMissingLastRevSeeker.getCandidates(long startTime)
Optional<NodeDocument>	MongoVersionGCSupport.getDocument(String id, List<String> fields)	Retrieves a document with the given id from the MongoDB collection.
Iterator<NodeDocument>	MongoBlobReferenceIterator.getIteratorOverDocsWithBinaries()
Iterable<NodeDocument>	MongoVersionGCSupport.getModifiedDocs(long fromModified, long toModified, int limit, @NotNull String fromId, @NotNull Set<String> includedPathPrefixes, @NotNull Set<String> excludedPathPrefixes)	Returns documents that have a MODIFIED_IN_SECS value within the given range and are greater than given @Document.ID.
Optional<NodeDocument>	MongoVersionGCSupport.getOldestModifiedDoc(Clock clock)	Retrieve the time of the oldest modified document.
CloseableIterable<NodeDocument>	MongoVersionGCSupport.getPossiblyDeletedDocs(long fromModified, long toModified)
protected Iterable<NodeDocument>	MongoVersionGCSupport.identifyGarbage(Set<NodeDocument.SplitDocType> gcTypes, RevisionVector sweepRevs, long oldestRevTimeStamp)

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

Methods in org.apache.jackrabbit.oak.plugins.document.rdb that return types with arguments of type NodeDocument

Modifier and Type	Method	Description
@NotNull Iterable<NodeDocument>	RDBMissingLastRevSeeker.getCandidates(long startTime)
Iterator<NodeDocument>	RDBBlobReferenceIterator.getIteratorOverDocsWithBinaries()
Iterable<NodeDocument>	RDBVersionGCSupport.getPossiblyDeletedDocs(long fromModified, long toModified)
protected Iterable<NodeDocument>	RDBVersionGCSupport.identifyGarbage(Set<NodeDocument.SplitDocType> gcTypes, RevisionVector sweepRevs, long oldestRevTimeStamp)

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

Methods in org.apache.jackrabbit.oak.plugins.document.util that return NodeDocument

Modifier and Type	Method	Description
static @NotNull NodeDocument	Utils.getRootDocument(@NotNull DocumentStore store)	Returns the root node document of the given document store.

Methods in org.apache.jackrabbit.oak.plugins.document.util that return types with arguments of type NodeDocument

Modifier and Type	Method	Description
static Iterable<NodeDocument>	Utils.getAllDocuments(DocumentStore store)	Returns an Iterable over all NodeDocuments in the given store.
static Iterable<NodeDocument>	Utils.getSelectedDocuments(DocumentStore store, String indexedProperty, long startValue)	Like Utils.getSelectedDocuments(DocumentStore, String, long, int) with a default batchSize.
static Iterable<NodeDocument>	Utils.getSelectedDocuments(DocumentStore store, String indexedProperty, long startValue, int batchSize)	Returns an Iterable over all NodeDocuments in the given store matching a condition on an indexed property.
static Iterable<NodeDocument>	Utils.getSelectedDocuments(DocumentStore store, String indexedProperty, long startValue, @NotNull Set<String> includePaths, @NotNull Set<String> excludePaths)	Like Utils.getSelectedDocuments(DocumentStore, String, long, int) with a default batchSize.
static Iterable<NodeDocument>	Utils.getSelectedDocuments(DocumentStore store, String indexedProperty, long startValue, String fromId)	Like Utils.getSelectedDocuments(DocumentStore, String, long, int) with a default batchSize.
static Iterable<NodeDocument>	Utils.getSelectedDocuments(DocumentStore store, String indexedProperty, long startValue, String fromId, @NotNull Set<String> includePaths, @NotNull Set<String> excludePaths)	Like Utils.getSelectedDocuments(DocumentStore, String, long, int) with a default batchSize.

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

Modifier and Type	Method	Description
static void	Utils.alignWithExternalRevisions(@NotNull NodeDocument rootDoc, @NotNull Clock clock, int clusterId, long warnThresholdMillis)	Makes sure the current time is after the most recent external revision timestamp in the _lastRev map of the given root document.