## Uses of Interface
org.modeshape.jcr.value.Path.Segment

- Packages that use Path.Segment
  Package | Description
  --- | ---
  org.modeshape.jcr.cache |
  org.modeshape.jcr.cache.change |
  org.modeshape.jcr.cache.document |
  org.modeshape.jcr.query.lucene | The core query engine, which currently uses Lucene for indexing and raw queries, and the Hibernate Search engine (which does not depend on or use Hibernate Core or JPA) for updating and querying the Lucene indexes.
  org.modeshape.jcr.value | Nodes in a graph contain properties, and this package defines the interfaces, classes and exceptions for representing and working with properties and their values.
  org.modeshape.jcr.value.basic | A set of basic implementations of the various interfaces defined in `org.modeshape.jcr.value`.
  org.modeshape.jcr.value.binary |

- - ### Uses of Path.Segment in org.modeshape.jcr.cache

    Methods in org.modeshape.jcr.cache that return Path.Segment
    Modifier and Type | Method and Description
    --- | ---
    `Path.Segment` | ChildReference.`getSegment()`
    `Path.Segment` | CachedNode.`getSegment(NodeCache cache)` Get the path segment for this node.

    Methods in org.modeshape.jcr.cache with parameters of type Path.Segment
    Modifier and Type | Method and Description
    --- | ---
    `ChildReference` | ChildReferences.`getChild(Path.Segment segment)` Look for the child reference that has the given name and SNS index.

    Constructors in org.modeshape.jcr.cache with parameters of type Path.Segment
    Constructor and Description
    `ChildReference(NodeKey key, Path.Segment segment)`

  - ### Uses of Path.Segment in org.modeshape.jcr.cache.change

    Methods in org.modeshape.jcr.cache.change that return Path.Segment
    Modifier and Type | Method and Description
    --- | ---
    `Path.Segment` | NodeRenamed.`getOldSegment()` Get the old segment for the node.

    Methods in org.modeshape.jcr.cache.change with parameters of type Path.Segment
    Modifier and Type | Method and Description
    --- | ---
    `void` | RecordingChanges.`nodeRenamed(NodeKey key, Path newPath, Path.Segment oldName)`
    `void` | NoOpChanges.`nodeRenamed(NodeKey key, Path path, Path.Segment oldName)`
    `void` | Changes.`nodeRenamed(NodeKey key, Path newPath, Path.Segment oldName)` Signal that a node was renamed (but still has the same parent)

    Constructors in org.modeshape.jcr.cache.change with parameters of type Path.Segment
    Constructor and Description
    `NodeRenamed(NodeKey key, Path newPath, Path.Segment oldSegment)`

  - ### Uses of Path.Segment in org.modeshape.jcr.cache.document

    Methods in org.modeshape.jcr.cache.document that return Path.Segment
    Modifier and Type | Method and Description
    --- | ---
    `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.
    `protected Path.Segment` | LazyCachedNode.`getSegment(WorkspaceCache cache)` Get the name for this node, without any same-name-sibiling (SNS) index.

    Methods in org.modeshape.jcr.cache.document that return types with arguments of type Path.Segment
    Modifier and Type | Method and Description
    --- | ---
    `protected List<Path.Segment>` | DocumentTranslator.`segmentsFrom(List<?> segmentValues)`

    Methods in org.modeshape.jcr.cache.document with parameters of type Path.Segment
    Modifier and Type | Method and Description
    --- | ---
    `ChildReference` | ImmutableChildReferences.EmptyChildReferences.`getChild(Path.Segment segment)`
    `ChildReference` | AbstractChildReferences.`getChild(Path.Segment segment)`

  - ### Uses of Path.Segment in org.modeshape.jcr.query.lucene

    Fields in org.modeshape.jcr.query.lucene with type parameters of type Path.Segment
    Modifier and Type | Field and Description
    --- | ---
    `protected static CompareQuery.Evaluator<Path.Segment>` | CompareNameQuery.`EQUAL_TO`
    `protected static CompareQuery.Evaluator<Path.Segment>` | CompareNameQuery.`EQUAL_TO_NO_SNS`
    `protected static CompareQuery.Evaluator<Path.Segment>` | CompareNameQuery.`IS_GREATER_THAN`
    `protected static CompareQuery.Evaluator<Path.Segment>` | CompareNameQuery.`IS_GREATER_THAN_NO_SNS`
    `protected static CompareQuery.Evaluator<Path.Segment>` | CompareNameQuery.`IS_GREATER_THAN_OR_EQUAL_TO`
    `protected static CompareQuery.Evaluator<Path.Segment>` | CompareNameQuery.`IS_GREATER_THAN_OR_EQUAL_TO_NO_SNS`
    `protected static CompareQuery.Evaluator<Path.Segment>` | CompareNameQuery.`IS_LESS_THAN`
    `protected static CompareQuery.Evaluator<Path.Segment>` | CompareNameQuery.`IS_LESS_THAN_NO_SNS`
    `protected static CompareQuery.Evaluator<Path.Segment>` | CompareNameQuery.`IS_LESS_THAN_OR_EQUAL_TO`
    `protected static CompareQuery.Evaluator<Path.Segment>` | CompareNameQuery.`IS_LESS_THAN_OR_EQUAL_TO_NO_SNS`

    Methods in org.modeshape.jcr.query.lucene that return Path.Segment
    Modifier and Type | Method and Description
    --- | ---
    `protected Path.Segment` | CompareNameQuery.`readFromDocument(org.apache.lucene.index.IndexReader reader, int docId)`

    Methods in org.modeshape.jcr.query.lucene with parameters of type Path.Segment
    Modifier and Type | Method and Description
    --- | ---
    `static org.apache.lucene.search.Query` | CompareNameQuery.`createQueryForNodesWithNameEqualTo(Path.Segment constraintValue, String localNameField, String snsIndexFieldName, ValueFactories factories, CaseOperations.CaseOperation caseOperation, boolean includeSns)` Construct a `Query` implementation that scores documents such that the node represented by the document has a name that is greater than the supplied constraint name.
    `static CompareNameQuery` | CompareNameQuery.`createQueryForNodesWithNameGreaterThan(Path.Segment constraintValue, String localNameField, String snsIndexFieldName, ValueFactories factories, CaseOperations.CaseOperation caseOperation, boolean includeSns)` Construct a `Query` implementation that scores documents such that the node represented by the document has a name that is greater than the supplied constraint name.
    `static CompareNameQuery` | CompareNameQuery.`createQueryForNodesWithNameGreaterThanOrEqualTo(Path.Segment constraintValue, String localNameField, String snsIndexFieldName, ValueFactories factories, CaseOperations.CaseOperation caseOperation, boolean includeSns)` Construct a `Query` implementation that scores documents such that the node represented by the document has a name that is greater than or equal to the supplied constraint name.
    `static CompareNameQuery` | CompareNameQuery.`createQueryForNodesWithNameLessThan(Path.Segment constraintValue, String localNameField, String snsIndexFieldName, ValueFactories factories, CaseOperations.CaseOperation caseOperation, boolean includeSns)` Construct a `Query` implementation that scores documents such that the node represented by the document has a name that is less than the supplied constraint name.
    `static CompareNameQuery` | CompareNameQuery.`createQueryForNodesWithNameLessThanOrEqualTo(Path.Segment constraintValue, String localNameField, String snsIndexFieldName, ValueFactories factories, CaseOperations.CaseOperation caseOperation, boolean includeSns)` Construct a `Query` implementation that scores documents such that the node represented by the document has a name that is less than or equal to the supplied constraint name.

    Constructors in org.modeshape.jcr.query.lucene with parameters of type Path.Segment
    Constructor and Description
    `CompareNameQuery(String localNameField, String snsIndexFieldName, Path.Segment constraintValue, PathFactory pathFactory, ValueFactory<String> stringFactory, ValueFactory<Long> longFactory, CompareQuery.Evaluator<Path.Segment> evaluator, CaseOperations.CaseOperation caseOperation)` Construct a `Query` implementation that scores nodes according to the supplied comparator.

    Constructor parameters in org.modeshape.jcr.query.lucene with type arguments of type Path.Segment
    Constructor and Description
    `CompareNameQuery(String localNameField, String snsIndexFieldName, Path.Segment constraintValue, PathFactory pathFactory, ValueFactory<String> stringFactory, ValueFactory<Long> longFactory, CompareQuery.Evaluator<Path.Segment> evaluator, CaseOperations.CaseOperation caseOperation)` Construct a `Query` implementation that scores nodes according to the supplied comparator.

  - ### Uses of Path.Segment in org.modeshape.jcr.value

    Fields in org.modeshape.jcr.value declared as Path.Segment
    Modifier and Type | Field and Description
    --- | ---
    `static Path.Segment` | Path.`PARENT_SEGMENT` Singleton instance of the path segment referencing a parent, provided as a convenience.
    `static Path.Segment` | Path.`SELF_SEGMENT` Singleton instance of the path segment referencing a parent, provided as a convenience.

    Fields in org.modeshape.jcr.value with type parameters of type Path.Segment
    Modifier and Type | Field and Description
    --- | ---
    `static Comparator<Path.Segment>` | ValueComparators.`PATH_SEGMENT_COMPARATOR` A comparator of path segment values.
    `static Comparator<Path.Segment>` | ValueComparators.`PATH_SEGMENT_NAME_COMPARATOR` A comparator of path segment names, excluding same-name-sibling indexes.

    Methods in org.modeshape.jcr.value that return Path.Segment
    Modifier and Type | Method and Description
    --- | ---
    `Path.Segment` | PathFactory.`createSegment(Name segmentName)` Create a path segment given the supplied segment name.
    `Path.Segment` | PathFactory.`createSegment(Name segmentName, int index)` Create a path segment given the supplied segment name and index.
    `Path.Segment` | PathFactory.`createSegment(String segmentName)` Create a path segment given the supplied segment name.
    `Path.Segment` | PathFactory.`createSegment(String segmentName, int index)` Create a path segment given the supplied segment name and index.
    `Path.Segment` | PathFactory.`createSegment(String segmentName, TextDecoder decoder)` Create a path segment given the supplied segment name.
    `Path.Segment` | Path.`getLastSegment()` Get the last segment in this path.
    `Path.Segment` | Path.`getSegment(int index)` Get the segment at the supplied index.
    `Path.Segment[]` | Path.`getSegmentsArray()` Obtain a copy of the segments in this path.

    Methods in org.modeshape.jcr.value that return types with arguments of type Path.Segment
    Modifier and Type | Method and Description
    --- | ---
    `List<Path.Segment>` | Path.`getSegmentsList()` Get an unmodifiable list of the path segments.

    Methods in org.modeshape.jcr.value with parameters of type Path.Segment
    Modifier and Type | Method and Description
    --- | ---
    `T` | ValueFactory.`create(Path.Segment value)` Create a value from a path segment.
    `Path` | PathFactory.`create(Path parentPath, Path.Segment... segments)` Create a path by appending the supplied names to the parent path.
    `Path` | PathFactory.`createAbsolutePath(Path.Segment... segments)` Create an absolute path with the supplied segments, in order.
    `Path` | PathFactory.`createRelativePath(Path.Segment... segments)` Create a relative path with the supplied segments, in order.

    Method parameters in org.modeshape.jcr.value with type arguments of type Path.Segment
    Modifier and Type | Method and Description
    --- | ---
    `Path` | PathFactory.`create(Path parentPath, Iterable<Path.Segment> segments)` Create a path by appending the supplied names to the parent path.
    `Path` | PathFactory.`createAbsolutePath(Iterable<Path.Segment> segments)` Create an absolute path with the supplied segments, in order.
    `Path` | PathFactory.`createRelativePath(Iterable<Path.Segment> segments)` Create a relative path with the supplied segments, in order.

  - ### Uses of Path.Segment in org.modeshape.jcr.value.basic

    Classes in org.modeshape.jcr.value.basic that implement Path.Segment
    Modifier and Type | Class and Description
    --- | ---
    `class` | `BasicPathSegment` A basic implementation of `Path.Segment`.
    `class` | `IdentifierPathSegment` A `Path.Segment` implementation that represents an identifier segment.

    Fields in org.modeshape.jcr.value.basic with type parameters of type Path.Segment
    Modifier and Type | Field and Description
    --- | ---
    `protected static Iterator<Path.Segment>` | AbstractPath.`EMPTY_PATH_ITERATOR`

    Methods in org.modeshape.jcr.value.basic that return Path.Segment
    Modifier and Type | Method and Description
    --- | ---
    `Path.Segment` | PathValueFactory.`createSegment(Name segmentName)`
    `Path.Segment` | PathValueFactory.`createSegment(Name segmentName, int index)`
    `Path.Segment` | PathValueFactory.`createSegment(String segmentName)`
    `Path.Segment` | PathValueFactory.`createSegment(String segmentName, int index)`
    `Path.Segment` | PathValueFactory.`createSegment(String segmentName, TextDecoder decoder)`
    `Path.Segment` | RootPath.`getLastSegment()`
    `Path.Segment` | IdentifierPath.`getLastSegment()`
    `Path.Segment` | ChildPath.`getLastSegment()`
    `Path.Segment` | AbstractPath.`getLastSegment()`
    `Path.Segment` | RootPath.`getSegment(int index)`
    `Path.Segment` | IdentifierPath.`getSegment(int index)`
    `Path.Segment` | ChildPath.`getSegment(int index)`
    `Path.Segment` | AbstractPath.`getSegment(int index)`
    `Path.Segment[]` | RootPath.`getSegmentsArray()`
    `Path.Segment[]` | IdentifierPath.`getSegmentsArray()`
    `Path.Segment[]` | AbstractPath.`getSegmentsArray()`

    Methods in org.modeshape.jcr.value.basic that return types with arguments of type Path.Segment
    Modifier and Type | Method and Description
    --- | ---
    `protected List<Path.Segment>` | AbstractPath.`createSegmentsSubList(int validBeginIndex, int validEndIndex)`
    `List<Path.Segment>` | RootPath.`getSegmentsList()`
    `List<Path.Segment>` | IdentifierPath.`getSegmentsList()`
    `List<Path.Segment>` | ChildPath.`getSegmentsList()`
    `List<Path.Segment>` | BasicPath.`getSegmentsList()`
    `protected Iterator<Path.Segment>` | RootPath.`getSegmentsOfParent()`
    `protected Iterator<Path.Segment>` | IdentifierPath.`getSegmentsOfParent()`
    `protected Iterator<Path.Segment>` | ChildPath.`getSegmentsOfParent()`
    `protected Iterator<Path.Segment>` | BasicPath.`getSegmentsOfParent()`
    `protected abstract Iterator<Path.Segment>` | AbstractPath.`getSegmentsOfParent()` Method used by `AbstractPath.equals(Object)` implementation to quickly get an Iterator over the segments in the parent.
    `Iterator<Path.Segment>` | RootPath.`iterator()`
    `Iterator<Path.Segment>` | IdentifierPath.`iterator()`
    `Iterator<Path.Segment>` | ChildPath.`iterator()`
    `Iterator<Path.Segment>` | AbstractPath.`iterator()`

    Methods in org.modeshape.jcr.value.basic with parameters of type Path.Segment
    Modifier and Type | Method and Description
    --- | ---
    `int` | BasicPathSegment.`compareTo(Path.Segment that)`
    `UUID` | UuidValueFactory.`create(Path.Segment value)`
    `URI` | UriValueFactory.`create(Path.Segment value)`
    `String` | StringValueFactory.`create(Path.Segment value)`
    `Reference` | ReferenceValueFactory.`create(Path.Segment value)`
    `Path` | PathValueFactory.`create(Path.Segment value)`
    `Object` | ObjectValueFactory.`create(Path.Segment value)`
    `Name` | NameValueFactory.`create(Path.Segment segment)`
    `Long` | LongValueFactory.`create(Path.Segment value)`
    `DateTime` | JodaDateTimeValueFactory.`create(Path.Segment value)`
    `Double` | DoubleValueFactory.`create(Path.Segment value)`
    `BigDecimal` | DecimalValueFactory.`create(Path.Segment value)`
    `Boolean` | BooleanValueFactory.`create(Path.Segment value)`
    `Path` | PathValueFactory.`create(Path parentPath, Path.Segment... segments)`
    `Path` | PathValueFactory.`createAbsolutePath(Path.Segment... segments)`
    `Path` | PathValueFactory.`createRelativePath(Path.Segment... segments)`

    Method parameters in org.modeshape.jcr.value.basic with type arguments of type Path.Segment
    Modifier and Type | Method and Description
    --- | ---
    `Path` | PathValueFactory.`create(Path parentPath, Iterable<Path.Segment> segments)`
    `Path` | PathValueFactory.`createAbsolutePath(Iterable<Path.Segment> segments)`
    `Path` | PathValueFactory.`createRelativePath(Iterable<Path.Segment> segments)`
    `protected boolean` | AbstractPath.`isNormalized(List<Path.Segment> segments)`

    Constructors in org.modeshape.jcr.value.basic with parameters of type Path.Segment
    Constructor and Description
    `ChildPath(Path parent, Path.Segment child)`

    Constructor parameters in org.modeshape.jcr.value.basic with type arguments of type Path.Segment
    Constructor and Description
    `BasicPath(List<Path.Segment> segments, boolean absolute)`

  - ### Uses of Path.Segment in org.modeshape.jcr.value.binary

    Methods in org.modeshape.jcr.value.binary with parameters of type Path.Segment
    Modifier and Type | Method and Description
    --- | ---
    `BinaryValue` | BinaryStoreValueFactory.`create(Path.Segment value)`

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