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

- Packages that use CachedNode
  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.
  org.modeshape.jcr.query.engine.process | When executing a query, the processing phase involves "running" each branch in the optimized query plan, determining the set of nodes that satisfies each branch, and then joining each branch into a single result.

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

    Methods in org.modeshape.jcr that return CachedNode
    Modifier and Type | Method and Description
    --- | ---
    `CachedNode` | SystemContent.`indexesNode()`
    `CachedNode` | SystemContent.`locksNode()`
    `CachedNode` | SystemContent.`namespacesNode()`
    `CachedNode` | SystemContent.`nodeTypesNode()`
    `CachedNode` | SystemContent.`systemNode()`
    `CachedNode` | SystemContent.`versionStorageNode()`

    Methods in org.modeshape.jcr with parameters of type CachedNode
    Modifier and Type | Method and Description
    --- | ---
    `protected Iterable<?>` | SystemContent.`all(CachedNode node, Name propertyName)`
    `protected Object` | SystemContent.`first(CachedNode node, Name propertyName)`
    `protected Object` | SystemContent.`first(CachedNode node, Name propertyName, Object defaultValue)`
    `protected String` | JcrSession.`readableLocation(CachedNode node)`
    `protected NodeDefinition` | SystemContent.`readChildNodeDefinition(CachedNode childDefn)`
    `IndexColumnDefinition` | SystemContent.`readIndexColumnDefinition(CachedNode indexColumnDefn)`
    `IndexDefinition` | SystemContent.`readIndexDefinition(CachedNode indexDefn, Name providerName)`
    `NodeTypeDefinition` | SystemContent.`readNodeTypeDefinition(CachedNode nodeType)`
    `protected PropertyDefinition` | SystemContent.`readPropertyDefinition(CachedNode propDefn)`
    `MutableCachedNode` | SystemContent.`recordNewVersion(CachedNode versionableNode, SessionCache cacheForVersionableNode, Path versionHistoryPath, NodeKey originalVersionKey, Collection<Property> versionableProperties, DateTime now, AtomicReference<MutableCachedNode> frozenNodeOutput)` The method efficiently updates the JCR version history and storage with a new version of a node being checked in.

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

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

    Methods in org.modeshape.jcr.cache that return CachedNode
    Modifier and Type | Method and Description
    --- | ---
    `CachedNode` | SessionCacheWrapper.`getNode(ChildReference reference)`
    `CachedNode` | NodeCache.`getNode(ChildReference reference)` Get the cached representation of the node as represented by the supplied child reference.
    `CachedNode` | SessionCacheWrapper.`getNode(NodeKey key)`
    `CachedNode` | CachedNodeSupplier.`getNode(NodeKey key)` Get the cached representation of the node with the supplied node key.

    Methods in org.modeshape.jcr.cache that return types with arguments of type CachedNode
    Modifier and Type | Method and Description
    --- | ---
    `protected Cache<NodeKey,CachedNode>` | RepositoryCache.`cacheForWorkspace(String name)`

    Methods in org.modeshape.jcr.cache with parameters of type CachedNode
    Modifier and Type | Method and Description
    --- | ---
    `void` | SessionCacheWrapper.`clear(CachedNode node)`
    `void` | SessionCache.`clear(CachedNode node)` Clears all changes in the cache that are at or below the supplied node.
    `static SiblingCounter` | SiblingCounter.`create(CachedNode node, NodeCache cache)` Creates a sibling counter that lazily obtains a `ChildReferences`.
    `void` | MutableCachedNode.`deepClone(SessionCache cache, CachedNode sourceNode, SessionCache sourceCache, String systemWorkspaceKey, Connectors connectors)` Clones into this node all the properties and children (deep clone) from the given source node.
    `Map<NodeKey,NodeKey>` | MutableCachedNode.`deepCopy(SessionCache cache, CachedNode sourceNode, SessionCache sourceCache, String systemWorkspaceKey, Connectors connectors)` Copies into this node all the properties and children (deep copy) from the given source node.
    `protected Set<NodeKey>` | AllPathsCache.`getAdditionalParentKeys(CachedNode node, NodeCache cache)`
    `Set<NodeKey>` | SessionCacheWrapper.`getChangedNodeKeysAtOrBelow(CachedNode node)`
    `Set<NodeKey>` | SessionCache.`getChangedNodeKeysAtOrBelow(CachedNode node)` Returns a set with the `NodeKey`s of the transient nodes from this cache which are at or below the path of the given node
    `Path` | PathCache.`getPath(CachedNode node)`
    `Iterable<Path>` | AllPathsCache.`getPaths(CachedNode node)` Get all of the paths through which the specified node is accessible, including all paths based upon the node's `parent` (which can potentially have multiple paths) and upon the node's `additional parents` (which each can potentially have multiple paths).

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

    Classes in org.modeshape.jcr.cache.document that implement CachedNode
    Modifier and Type | Class and Description
    --- | ---
    `class` | `LazyCachedNode` This is a (mostly) immutable `CachedNode` implementation that lazily loads its content.
    `class` | `SessionNode` A node used within a `session` when that node has (or may have) transient (unsaved) changes.

    Fields in org.modeshape.jcr.cache.document declared as CachedNode
    Modifier and Type | Field and Description
    --- | ---
    `protected CachedNode` | SessionNode.DeepCopy.`sourceNode`

    Methods in org.modeshape.jcr.cache.document that return CachedNode
    Modifier and Type | Method and Description
    --- | ---
    `CachedNode` | WorkspaceCache.`getNode(ChildReference reference)`
    `CachedNode` | AbstractSessionCache.`getNode(ChildReference reference)`
    `CachedNode` | WritableSessionCache.`getNode(NodeKey key)`
    `CachedNode` | WorkspaceCache.`getNode(NodeKey key)`
    `CachedNode` | AbstractSessionCache.`getNode(NodeKey key)`
    `protected CachedNode` | SessionNode.`nodeInWorkspace(AbstractSessionCache session)` Get the CachedNode within the workspace cache.
    `protected CachedNode` | SessionNode.`parent(AbstractSessionCache session)`
    `protected CachedNode` | LazyCachedNode.`parent(WorkspaceCache cache)`

    Methods in org.modeshape.jcr.cache.document with parameters of type CachedNode
    Modifier and Type | Method and Description
    --- | ---
    `void` | AbstractSessionCache.`clear(CachedNode node)`
    `protected void` | SessionNode.DeepCopy.`copyProperties(MutableCachedNode targetNode, CachedNode sourceNode)`
    `protected void` | SessionNode.DeepClone.`copyProperties(MutableCachedNode targetNode, CachedNode sourceNode)`
    `protected void` | SessionNode.DeepCopy.`copyUUIDProperty(Property sourceProperty, MutableCachedNode targetNode, CachedNode sourceNode)`
    `protected void` | SessionNode.DeepClone.`copyUUIDProperty(Property sourceProperty, MutableCachedNode targetNode, CachedNode sourceNode)`
    `void` | SessionNode.`deepClone(SessionCache cache, CachedNode sourceNode, SessionCache sourceCache, String systemWorkspaceKey, Connectors connectors)`
    `Map<NodeKey,NodeKey>` | SessionNode.`deepCopy(SessionCache cache, CachedNode sourceNode, SessionCache sourceCache, String systemWorkspaceKey, Connectors connectors)`
    `protected void` | WritableSessionCache.`doClear(CachedNode node)`
    `protected void` | ReadOnlySessionCache.`doClear(CachedNode node)`
    `protected abstract void` | AbstractSessionCache.`doClear(CachedNode node)`
    `protected void` | SessionNode.DeepCopy.`doPhase1(MutableCachedNode targetNode, CachedNode sourceNode)` Perform a copy of the source tree to create a similar tree in the target session.
    `Set<NodeKey>` | WritableSessionCache.`getChangedNodeKeysAtOrBelow(CachedNode srcNode)`
    `Set<NodeKey>` | ReadOnlySessionCache.`getChangedNodeKeysAtOrBelow(CachedNode node)`
    `protected Path.Segment` | SessionNode.`getSegment(NodeCache cache, CachedNode parent)` Get the segment for this node.
    `boolean` | NodeCacheIterator.NodeFilter.`includeNode(CachedNode node, NodeCache cache)` Determine if the supplied node is to be included in the iterator.
    `boolean` | LazyCachedNode.ParentReferenceToSelf.`isValid(CachedNode recentParent)` Determine if this instance is still valid, given the supplied `CachedNode` instance that represents the most-recently acquired parent node representation.
    `boolean` | LazyCachedNode.RootParentReferenceToSelf.`isValid(CachedNode recentParent)`
    `boolean` | LazyCachedNode.NonRootParentReferenceToSelf.`isValid(CachedNode recentParent)`

    Constructors in org.modeshape.jcr.cache.document with parameters of type CachedNode
    Constructor and Description
    `LazyCachedNode.NonRootParentReferenceToSelf(CachedNode parent, ChildReference childReferenceInParent)`
    `SessionNode.DeepClone(SessionNode targetNode, WritableSessionCache cache, CachedNode sourceNode, SessionCache sourceCache, String systemWorkspaceKey, Connectors connectors)`
    `SessionNode.DeepCopy(SessionNode targetNode, WritableSessionCache cache, CachedNode sourceNode, SessionCache sourceCache, String systemWorkspaceKey, Connectors connectors)`

    Constructor parameters in org.modeshape.jcr.cache.document with type arguments of type CachedNode
    Constructor and Description
    `WorkspaceCache(ExecutionContext context, String repositoryKey, String workspaceName, WorkspaceCache systemWorkspace, DocumentStore documentStore, DocumentTranslator translator, NodeKey rootKey, ConcurrentMap<NodeKey,CachedNode> cache, ChangeBus changeBus)`
    `WorkspaceCache(WorkspaceCache original, ConcurrentMap<NodeKey,CachedNode> cache)`

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

    Fields in org.modeshape.jcr.query declared as CachedNode
    Modifier and Type | Field and Description
    --- | ---
    `protected CachedNode` | JcrQueryResult.SingleSelectorQueryResultRow.`cachedNode`

    Fields in org.modeshape.jcr.query with type parameters of type CachedNode
    Modifier and Type | Field and Description
    --- | ---
    `protected List<CachedNode>` | NodeSequence.SingleWidthBatch.`nodes`

    Methods in org.modeshape.jcr.query that return CachedNode
    Modifier and Type | Method and Description
    --- | ---
    `CachedNode` | NodeSequence.RowAccessor.`getNode()` Get the first node in the current row.
    `CachedNode` | NodeSequence.LimitBatch.`getNode()`
    `CachedNode` | NodeSequence.AlternateSizeBatch.`getNode()`
    `CachedNode` | NodeSequence.SingleWidthBatch.`getNode()`
    `CachedNode` | NodeSequence.RowAccessor.`getNode(int index)` Get the node at the specified index in the current row.
    `CachedNode` | NodeSequence.LimitBatch.`getNode(int index)`
    `CachedNode` | NodeSequence.AlternateSizeBatch.`getNode(int index)`
    `CachedNode` | NodeSequence.SingleWidthBatch.`getNode(int index)`

    Methods in org.modeshape.jcr.query with parameters of type CachedNode
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | JcrQueryContext.`canRead(CachedNode node)` Checks if there is a `ModeShapePermissions.READ` permission for the given node in this context.
    `protected static void` | RowExtractors.`extractFullTextFrom(Property property, TypeSystem.TypeFactory<String> type, StringBuilder fullTextString, BinaryStore binaries, CachedNode node, NodeCache cache)`
    `long` | JcrQueryContext.`getChildCount(CachedNode node)` Get the number of children of the supplied cached node.
    `long` | JcrQueryContext.`getDepth(CachedNode node)` Get the depth of the supplied cached node.
    `String` | JcrQueryContext.`getIdentifier(CachedNode node)` Get the internal `public JCR identifier` of the supplied cached node.
    `Name` | JcrQueryContext.`getName(CachedNode node)` Get the internal `Name` of the supplied cached node.
    `Node` | JcrQueryContext.`getNode(CachedNode node)` Obtain the JCR node given the supplied cached node.
    `Path` | JcrQueryContext.`getPath(CachedNode node)` Get the internal `Path` of the supplied cached node.
    `String` | JcrQueryContext.`getUuid(CachedNode node)` Get the UUID identifier of the supplied cached node.
    `protected Value` | JcrQueryResult.AbstractRow.`getValue(String columnName, CachedNode cachedNode, int nodeIndex)`
    `protected Value` | JcrQueryResult.QueryResultRowIterator.`jcrChildCount(CachedNode node)`
    `protected Value` | JcrQueryResult.QueryResultRowIterator.`jcrDepth(CachedNode node)`
    `protected Value` | JcrQueryResult.QueryResultRowIterator.`jcrId(CachedNode node)`
    `protected Value` | JcrQueryResult.QueryResultRowIterator.`jcrLocalName(CachedNode node)`
    `protected Value` | JcrQueryResult.QueryResultRowIterator.`jcrName(CachedNode node)`
    `protected Value` | JcrQueryResult.QueryResultRowIterator.`jcrPath(CachedNode node)`
    `protected Value` | JcrQueryResult.QueryResultRowIterator.`jcrUuid(CachedNode node)`
    `protected static NodeKey` | NodeSequence.`keyFor(CachedNode node)`
    `static NodeSequence` | NodeSequence.`withNode(CachedNode node, int width, float score, String workspaceName)`

    Method parameters in org.modeshape.jcr.query with type arguments of type CachedNode
    Modifier and Type | Method and Description
    --- | ---
    `static NodeSequence.Batch` | NodeSequence.`batchOf(Collection<CachedNode> nodes, float score, String workspaceName)` Create a batch of nodes around the supplied iterable container.
    `static NodeSequence.Batch` | NodeSequence.`batchOf(Iterator<CachedNode> nodes, long nodeCount, float score, String workspaceName)` Create a batch of nodes around the supplied iterator.
    `static NodeSequence` | NodeSequence.`withNodes(Collection<CachedNode> nodes, float score, String workspaceName)` Create a sequence of nodes that iterates over the supplied nodes.
    `static NodeSequence` | NodeSequence.`withNodes(Iterator<CachedNode> nodes, long nodeCount, float score, String workspaceName)` Create a sequence of nodes that iterates over the supplied nodes.

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

    Methods in org.modeshape.jcr.query.engine that return CachedNode
    Modifier and Type | Method and Description
    --- | ---
    `protected CachedNode` | QuerySources.`getNodeAtPath(Path path, NodeCache cache)`

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

  - ### Uses of CachedNode in org.modeshape.jcr.query.engine.process

    Methods in org.modeshape.jcr.query.engine.process that return CachedNode
    Modifier and Type | Method and Description
    --- | ---
    `protected static CachedNode` | BufferedRows.`deserializeNodeKey(String keyStr, CachedNodeSupplier cache)`
    `CachedNode` | JoinSequence.RightOnlyBatch.`getNode()`
    `CachedNode` | JoinSequence.LeftOnlyBatch.`getNode()`
    `CachedNode` | IntersectSequence.IntersectBatch.`getNode()`
    `CachedNode` | HashJoinSequence.HashJoinBatch.`getNode()`
    `CachedNode` | HashJoinSequence.RightRowsBatch.`getNode()`
    `CachedNode` | BufferedRows.SingleNodeRow.`getNode()`
    `CachedNode` | BufferedRows.DoubleNodeRow.`getNode()`
    `CachedNode` | BufferedRows.TripleNodeRow.`getNode()`
    `CachedNode` | BufferedRows.QuadNodeRow.`getNode()`
    `CachedNode` | BufferedRows.MultiNodeRow.`getNode()`
    `CachedNode` | JoinSequence.RightOnlyBatch.`getNode(int index)`
    `CachedNode` | JoinSequence.LeftOnlyBatch.`getNode(int index)`
    `CachedNode` | IntersectSequence.IntersectBatch.`getNode(int index)`
    `CachedNode` | HashJoinSequence.HashJoinBatch.`getNode(int index)`
    `CachedNode` | HashJoinSequence.RightRowsBatch.`getNode(int index)`
    `CachedNode` | BufferedRows.SingleNodeRow.`getNode(int index)`
    `CachedNode` | BufferedRows.DoubleNodeRow.`getNode(int index)`
    `CachedNode` | BufferedRows.TripleNodeRow.`getNode(int index)`
    `CachedNode` | BufferedRows.QuadNodeRow.`getNode(int index)`
    `CachedNode` | BufferedRows.MultiNodeRow.`getNode(int index)`

    Methods in org.modeshape.jcr.query.engine.process with parameters of type CachedNode
    Modifier and Type | Method and Description
    --- | ---
    `protected static String` | BufferedRows.`serializeNodeKey(CachedNode node)`

    Constructors in org.modeshape.jcr.query.engine.process with parameters of type CachedNode
    Constructor and Description
    `BufferedRows.DoubleNodeRow(CachedNode node1, CachedNode node2, float score1, float score2)`
    `BufferedRows.MultiNodeRow(CachedNode[] nodes, float[] scores)`
    `BufferedRows.QuadNodeRow(CachedNode node1, CachedNode node2, CachedNode node3, CachedNode node4, float score1, float score2, float score3, float score4)`
    `BufferedRows.SingleNodeRow(CachedNode node, float score)`
    `BufferedRows.TripleNodeRow(CachedNode node1, CachedNode node2, CachedNode node3, float score1, float score2, float score3)`

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