## Uses of Interface
org.modeshape.jcr.cache.NodeCache

- Packages that use NodeCache
  Package | Description
  --- | ---
  org.modeshape.jcr |
  org.modeshape.jcr.cache |
  org.modeshape.jcr.cache.document |
  org.modeshape.jcr.query | The Query API provides a mechanism for building and executing queries.
  org.modeshape.jcr.query.engine | This package contains several fully-functional query engine implementations.

- - ### Uses of NodeCache in org.modeshape.jcr

    Classes in org.modeshape.jcr that implement NodeCache
    Modifier and Type | Class and Description
    --- | ---
    `protected class` | `JcrSession.SystemSessionCache`

    Methods in org.modeshape.jcr that return NodeCache
    Modifier and Type | Method and Description
    --- | ---
    `protected NodeCache` | JcrRepository.`workspaceCache(String workspaceName)`

    Methods in org.modeshape.jcr with parameters of type NodeCache
    Modifier and Type | Method and Description
    --- | ---
    `void` | JcrSession.JcrPreSave.`processAfterLocking(MutableCachedNode modifiedNode, SessionCache.SaveContext context, NodeCache persistentNodeCache)`

  - ### Uses of NodeCache in org.modeshape.jcr.cache

    Subinterfaces of NodeCache in org.modeshape.jcr.cache
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `SessionCache`

    Classes in org.modeshape.jcr.cache that implement NodeCache
    Modifier and Type | Class and Description
    --- | ---
    `class` | `SessionCacheWrapper` A `SessionCache` implementation that wraps another and is suitable to extend and overwrite only those methods that are required.

    Fields in org.modeshape.jcr.cache declared as NodeCache
    Modifier and Type | Field and Description
    --- | ---
    `protected NodeCache` | AllPathsCache.`cache`
    `protected NodeCache` | AllPathsCache.`removedCache`

    Methods in org.modeshape.jcr.cache that return NodeCache
    Modifier and Type | Method and Description
    --- | ---
    `NodeCache` | PathCache.`getCache()`
    `NodeCache` | AllPathsCache.`getCache()`
    `NodeCache` | SessionCacheWrapper.`getWorkspace()`
    `NodeCache` | SessionCache.`getWorkspace()` Get the cache the reflects the workspace content, without any of the transient, unsaved changes of this session.
    `NodeCache` | NodeCache.`unwrap()` Unwrap this instance.

    Methods in org.modeshape.jcr.cache with parameters of type NodeCache
    Modifier and Type | Method and Description
    --- | ---
    `static SiblingCounter` | SiblingCounter.`create(CachedNode node, NodeCache cache)` Creates a sibling counter that lazily obtains a `ChildReferences`.
    `protected Set<NodeKey>` | AllPathsCache.`getAdditionalParentKeys(CachedNode node, NodeCache cache)`
    `Set<NodeKey>` | CachedNode.`getAdditionalParentKeys(NodeCache cache)` Get the keys for all of the nodes (other than the `primary parent`) under which this node appears.
    `ChildReferences` | CachedNode.`getChildReferences(NodeCache cache)` Get the set of child references for this node.
    `int` | CachedNode.`getDepth(NodeCache cache)` Get the depth of this node.
    `Set<Name>` | CachedNode.`getMixinTypes(NodeCache cache)` Get the set of mixin types for this node.
    `Name` | CachedNode.`getName(NodeCache cache)` Get the name for this node, without any same-name-sibiling (SNS) index.
    `NodeKey` | CachedNode.`getParentKey(NodeCache cache)` Get the node key for this node's primary parent within this workspace.
    `NodeKey` | CachedNode.`getParentKeyInAnyWorkspace(NodeCache cache)` Get the node key for this node's primary parent in any workspace.
    `Path` | CachedNode.`getPath(NodeCache cache)` Get the path to this node.
    `PathCache` | RepositoryPathCache.`getPathCache(String workspaceName, NodeCache nodeCacheForWorkspace)`
    `Map<String,Set<String>>` | CachedNode.`getPermissions(NodeCache cache)` Gets the map of privileges by principal name which are in effect for this node.
    `Name` | CachedNode.`getPrimaryType(NodeCache cache)` Get the primary type for this node.
    `Iterator<Property>` | CachedNode.`getProperties(Collection<?> namePatterns, NodeCache cache)` Get an iterator over all of the properties of this node that have names matching at least one of the supplied patterns.
    `Iterator<Property>` | CachedNode.`getProperties(NodeCache cache)` Get an iterator over all of the node's properties.
    `CachedNode.Properties` | CachedNode.`getPropertiesByName(NodeCache cache)` Get the properties collection.
    `Property` | CachedNode.`getProperty(Name name, NodeCache cache)` Get the property with the given name.
    `int` | CachedNode.`getPropertyCount(NodeCache cache)` Determine the number of properties that this node contains.
    `ReferrerCounts` | CachedNode.`getReferrerCounts(NodeCache cache)` Get a snapshot of the referrers that have REFERENCE and/or WEAK_REFERENCE properties pointing to this node.
    `Set<NodeKey>` | CachedNode.`getReferrers(NodeCache cache, CachedNode.ReferenceType type)` Get the keys of the nodes that have JCR REFERENCE and/or WEAK_REFERENCE properties pointing to this node.
    `Path.Segment` | CachedNode.`getSegment(NodeCache cache)` Get the path segment for this node.
    `boolean` | CachedNode.`hasACL(NodeCache cache)` Determine if there is an access control list for this node only, not taking into account any possible parents.
    `boolean` | CachedNode.`hasProperties(NodeCache cache)` Determine if the node contains one or more properties.
    `boolean` | CachedNode.`hasProperty(Name name, NodeCache cache)` Determine if the node contains a property with the specified name.
    `boolean` | CachedNode.`isAtOrBelow(NodeCache cache, Path path)` Determine if this node is effectively at or below the supplied path.
    `boolean` | CachedNode.`isExternal(NodeCache cache)` Determine if this node belongs to an external source (via federation) or is local to the repository.
    `boolean` | CachedNode.`isQueryable(NodeCache cache)` Determine if this node should be indexed and therefore available for querying.
    `void` | SessionCache.PreSave.`processAfterLocking(MutableCachedNode modifiedNode, SessionCache.SaveContext context, NodeCache persistentNodeCache)` Process the supplied existing node prior to saving the changes but only after the entry corresponding to the key of the node has been locked in Infinispan.

    Constructors in org.modeshape.jcr.cache with parameters of type NodeCache
    Constructor and Description
    `AllPathsCache(NodeCache cache, NodeCache removedCache, ExecutionContext context)`
    `AllPathsCache(NodeCache cache, NodeCache removedCache, PathFactory pathFactory)`
    `PathCache(NodeCache cache)`

  - ### Uses of NodeCache in org.modeshape.jcr.cache.document

    Subinterfaces of NodeCache in org.modeshape.jcr.cache.document
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `DocumentCache`

    Classes in org.modeshape.jcr.cache.document that implement NodeCache
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AbstractSessionCache`
    `class` | `ReadOnlySessionCache` A read-only `SessionCache` implementation.
    `class` | `TransactionalWorkspaceCache` A special WorkspaceCache implementation that should be used by sessions running within user transactions.
    `class` | `WorkspaceCache` A `NodeCache` implementation that uses Infinispan's `SchematicDb` for storage, with each node represented as a single `Document`.
    `class` | `WritableSessionCache` A writable `SessionCache` implementation capable of making transient changes and saving them.

    Methods in org.modeshape.jcr.cache.document that return NodeCache
    Modifier and Type | Method and Description
    --- | ---
    `NodeCache` | AbstractSessionCache.`getWorkspace()`
    `NodeCache` | WorkspaceCache.`unwrap()`

    Methods in org.modeshape.jcr.cache.document with parameters of type NodeCache
    Modifier and Type | Method and Description
    --- | ---
    `Set<NodeKey>` | SessionNode.`getAdditionalParentKeys(NodeCache cache)`
    `Set<NodeKey>` | LazyCachedNode.`getAdditionalParentKeys(NodeCache cache)`
    `ChildReferences` | SessionNode.`getChildReferences(NodeCache cache)`
    `ChildReferences` | LazyCachedNode.`getChildReferences(NodeCache cache)`
    `int` | SessionNode.`getDepth(NodeCache cache)`
    `int` | LazyCachedNode.`getDepth(NodeCache cache)`
    `Set<Name>` | SessionNode.`getMixinTypes(NodeCache cache)`
    `Set<Name>` | LazyCachedNode.`getMixinTypes(NodeCache cache)`
    `Name` | SessionNode.`getName(NodeCache cache)`
    `Name` | LazyCachedNode.`getName(NodeCache cache)`
    `NodeKey` | SessionNode.`getParentKey(NodeCache cache)`
    `NodeKey` | LazyCachedNode.`getParentKey(NodeCache cache)`
    `NodeKey` | SessionNode.`getParentKeyInAnyWorkspace(NodeCache cache)`
    `NodeKey` | LazyCachedNode.`getParentKeyInAnyWorkspace(NodeCache cache)`
    `Path` | SessionNode.`getPath(NodeCache cache)`
    `Path` | LazyCachedNode.`getPath(NodeCache cache)`
    `Map<String,Set<String>>` | SessionNode.`getPermissions(NodeCache cache)`
    `Map<String,Set<String>>` | LazyCachedNode.`getPermissions(NodeCache cache)`
    `Name` | SessionNode.`getPrimaryType(NodeCache cache)`
    `Name` | LazyCachedNode.`getPrimaryType(NodeCache cache)`
    `Iterator<Property>` | SessionNode.`getProperties(Collection<?> namePatterns, NodeCache cache)`
    `Iterator<Property>` | LazyCachedNode.`getProperties(Collection<?> namePatterns, NodeCache cache)`
    `Iterator<Property>` | SessionNode.`getProperties(NodeCache cache)`
    `Iterator<Property>` | LazyCachedNode.`getProperties(NodeCache cache)`
    `CachedNode.Properties` | SessionNode.`getPropertiesByName(NodeCache cache)`
    `CachedNode.Properties` | LazyCachedNode.`getPropertiesByName(NodeCache cache)`
    `Property` | SessionNode.`getProperty(Name name, NodeCache cache)`
    `Property` | LazyCachedNode.`getProperty(Name name, NodeCache cache)`
    `int` | SessionNode.`getPropertyCount(NodeCache cache)`
    `int` | LazyCachedNode.`getPropertyCount(NodeCache cache)`
    `ReferrerCounts` | SessionNode.`getReferrerCounts(NodeCache cache)`
    `ReferrerCounts` | LazyCachedNode.`getReferrerCounts(NodeCache cache)`
    `Set<NodeKey>` | SessionNode.`getReferrers(NodeCache cache, CachedNode.ReferenceType type)`
    `Set<NodeKey>` | LazyCachedNode.`getReferrers(NodeCache cache, CachedNode.ReferenceType type)`
    `Path.Segment` | SessionNode.`getSegment(NodeCache cache)`
    `Path.Segment` | LazyCachedNode.`getSegment(NodeCache cache)`
    `protected Path.Segment` | SessionNode.`getSegment(NodeCache cache, CachedNode parent)` Get the segment for this node.
    `boolean` | SessionNode.`hasACL(NodeCache cache)`
    `boolean` | LazyCachedNode.`hasACL(NodeCache cache)`
    `boolean` | SessionNode.`hasProperties(NodeCache cache)`
    `boolean` | LazyCachedNode.`hasProperties(NodeCache cache)`
    `boolean` | SessionNode.`hasProperty(Name name, NodeCache cache)`
    `boolean` | LazyCachedNode.`hasProperty(Name name, NodeCache cache)`
    `boolean` | NodeCacheIterator.NodeFilter.`includeNode(CachedNode node, NodeCache cache)` Determine if the supplied node is to be included in the iterator.
    `boolean` | SessionNode.`isAtOrBelow(NodeCache cache, Path path)`
    `boolean` | LazyCachedNode.`isAtOrBelow(NodeCache cache, Path path)`
    `boolean` | SessionNode.`isExternal(NodeCache cache)`
    `boolean` | LazyCachedNode.`isExternal(NodeCache cache)`
    `boolean` | SessionNode.`isQueryable(NodeCache cache)`
    `boolean` | LazyCachedNode.`isQueryable(NodeCache cache)`
    `protected void` | SessionNode.`replaceParentWithAdditionalParent(NodeCache cache, NodeKey oldParent, NodeKey existingAdditionalParent)`
    `protected AbstractSessionCache` | SessionNode.`session(NodeCache cache)`
    `protected WorkspaceCache` | SessionNode.`workspace(NodeCache cache)`
    `protected WorkspaceCache` | LazyCachedNode.`workspaceCache(NodeCache cache)`
    `protected WritableSessionCache` | SessionNode.`writableSession(NodeCache cache)`

    Constructors in org.modeshape.jcr.cache.document with parameters of type NodeCache
    Constructor and Description
    `NodeCacheIterator(NodeCache cache, NodeKey startingNode)` Create a new iterator over the nodes in the supplied node cache that are at or below the supplied starting node.
    `NodeCacheIterator(NodeCache cache, NodeKey startingNode, NodeCacheIterator.NodeFilter filter)` Create a new iterator over the nodes in the supplied node cache that are at or below the supplied starting node.

  - ### Uses of NodeCache in org.modeshape.jcr.query

    Fields in org.modeshape.jcr.query with type parameters of type NodeCache
    Modifier and Type | Field and Description
    --- | ---
    `protected Map<String,NodeCache>` | QueryContext.`overriddenNodeCachesByWorkspaceName`

    Methods in org.modeshape.jcr.query that return NodeCache
    Modifier and Type | Method and Description
    --- | ---
    `NodeCache` | QueryContext.`getNodeCache(String workspaceName)` Get the NodeCache for the given workspace name.

    Methods in org.modeshape.jcr.query with parameters of type NodeCache
    Modifier and Type | Method and Description
    --- | ---
    `static NodeSequence.Batch` | NodeSequence.`batchOfKeys(Iterator<NodeKey> keys, long nodeCount, float score, String workspaceName, NodeCache cache)` Create a batch of nodes around the supplied iterator.
    `static RowExtractors.ExtractFromRow` | RowExtractors.`extractFullText(int indexInRow, NodeCache cache, Name propertyName, TypeSystem types, BinaryStore binaries)` Obtain a new `RowExtractors.ExtractFromRow` instance that will extract the full text for a single property of a node.
    `static RowExtractors.ExtractFromRow` | RowExtractors.`extractFullText(int indexInRow, NodeCache cache, TypeSystem types, BinaryStore binaries)` Obtain a new `RowExtractors.ExtractFromRow` instance that will extract the full text for a node.
    `protected static void` | RowExtractors.`extractFullTextFrom(Property property, TypeSystem.TypeFactory<String> type, StringBuilder fullTextString, BinaryStore binaries, CachedNode node, NodeCache cache)`
    `static RowExtractors.ExtractFromRow` | RowExtractors.`extractLocalName(int indexInRow, NodeCache cache, TypeSystem types)` Create an extractor that extracts the name from the node at the given position in the row.
    `static RowExtractors.ExtractFromRow` | RowExtractors.`extractName(int indexInRow, NodeCache cache, TypeSystem types)` Create an extractor that extracts the name from the node at the given position in the row.
    `static RowExtractors.ExtractFromRow` | RowExtractors.`extractNodeKey(int indexInRow, NodeCache cache, TypeSystem types)` Create an extractor that extracts the `NodeKey` from the node at the given position in the row.
    `static RowExtractors.ExtractFromRow` | RowExtractors.`extractParentNodeKey(int indexInRow, NodeCache cache, TypeSystem types)` Create an extractor that extracts the parent's `NodeKey` from the node at the given position in the row.
    `static RowExtractors.ExtractFromRow` | RowExtractors.`extractParentPath(int indexInRow, NodeCache cache, TypeSystem types)` Create an extractor that extracts the parent path from the node at the given position in the row.
    `static RowExtractors.ExtractFromRow` | RowExtractors.`extractPath(int indexInRow, NodeCache cache, TypeSystem types)` Create an extractor that extracts the path from the node at the given position in the row.
    `static RowExtractors.ExtractFromRow` | RowExtractors.`extractPropertyValue(Name propertyName, int indexInRow, NodeCache cache, TypeSystem.TypeFactory<?> desiredType)` Create an extractor that extracts the property value from the node at the given position in the row.
    `static RowExtractors.ExtractFromRow` | RowExtractors.`extractRelativePath(int indexInRow, Path relativePath, NodeCache cache, TypeSystem types)` Create an extractor that extracts the path from the node at the given position in the row and applies the relative path.
    `static NodeSequence` | NodeSequence.`withNodeKeys(Collection<NodeKey> keys, float score, String workspaceName, NodeCache cache)` Create a sequence of nodes that iterates over the supplied node keys.
    `static NodeSequence` | NodeSequence.`withNodeKeys(Iterator<NodeKey> keys, long keyCount, float score, String workspaceName, NodeCache cache)` Create a sequence of nodes that iterates over the supplied node keys.

    Method parameters in org.modeshape.jcr.query with type arguments of type NodeCache
    Modifier and Type | Method and Description
    --- | ---
    `QueryContext` | QueryEngine.`createQueryContext(ExecutionContext context, RepositoryCache repositoryCache, Set<String> workspaceNames, Map<String,NodeCache> overriddenNodeCachesByWorkspaceName, Schemata schemata, RepositoryIndexes indexDefns, NodeTypes nodeTypes, BufferManager bufferManager, PlanHints hints, Map<String,Object> variables)` Create a new context for query execution.

    Constructor parameters in org.modeshape.jcr.query with type arguments of type NodeCache
    Constructor and Description
    `QueryContext(ExecutionContext context, RepositoryCache repositoryCache, Set<String> workspaceNames, Map<String,NodeCache> overriddenNodeCachesByWorkspaceName, Schemata schemata, RepositoryIndexes indexDefns, NodeTypes nodeTypes, BufferManager bufferManager, PlanHints hints, Problems problems, Map<String,Object> variables)` Create a new context for query execution.
    `QueryContext(ExecutionContext context, RepositoryCache repositoryCache, Set<String> workspaceNames, Map<String,NodeCache> overriddenNodeCachesByWorkspaceName, Schemata schemata, RepositoryIndexes indexDefns, NodeTypes nodeTypes, BufferManager bufferManager, PlanHints hints, Problems problems, Map<String,Object> variables, long id)` Create a new context for query execution.

  - ### Uses of NodeCache in org.modeshape.jcr.query.engine

    Methods in org.modeshape.jcr.query.engine with parameters of type NodeCache
    Modifier and Type | Method and Description
    --- | ---
    `protected CachedNode` | QuerySources.`getNodeAtPath(Path path, NodeCache cache)`
    `boolean` | QuerySources.CompositeNodeFilter.`includeNode(CachedNode node, NodeCache cache)`

    Method parameters in org.modeshape.jcr.query.engine with type arguments of type NodeCache
    Modifier and Type | Method and Description
    --- | ---
    `QueryContext` | ScanningQueryEngine.`createQueryContext(ExecutionContext context, RepositoryCache repositoryCache, Set<String> workspaceNames, Map<String,NodeCache> overriddenNodeCachesByWorkspaceName, Schemata schemata, RepositoryIndexes indexDefns, NodeTypes nodeTypes, BufferManager bufferManager, PlanHints hints, Map<String,Object> variables)`

Copyright © 2008-2014 JBoss, a division of Red Hat. All Rights Reserved.