org.hawkular.inventory.paths

Class CanonicalPath

java.lang.Object

org.hawkular.inventory.paths.Path

org.hawkular.inventory.paths.CanonicalPath

All Implemented Interfaces:

Serializable, Iterable<CanonicalPath>

public final class CanonicalPath
extends Path
implements Iterable<CanonicalPath>, Serializable

A path represents the canonical traversal to an element through the inventory graph. The canonical traversal always starts at a tenant and follows only the "contains" relationships down to the entity in question. For relationships the "traversal" comprises of merely referencing the relationship by its id.

For description of the basic behavior and serialized form of the path, please consult Path.

Since:

0.2.0

Author:

Lukas Krejci

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CanonicalPath.Builder
static class	CanonicalPath.EnvironmentBuilder
static class	CanonicalPath.Extender
static class	CanonicalPath.FeedBuilder
class	CanonicalPath.IdExtractor
static class	CanonicalPath.MetadataPackBuilder
static class	CanonicalPath.MetricBuilder
static class	CanonicalPath.MetricTypeBuilder
static class	CanonicalPath.OperationTypeBuilder
static class	CanonicalPath.RelationshipBuilder
static class	CanonicalPath.ResourceBuilder
static class	CanonicalPath.ResourceTypeBuilder
static class	CanonicalPath.StructuredDataBuilder
static class	CanonicalPath.TenantBuilder

Nested classes/interfaces inherited from class org.hawkular.inventory.paths.Path

Path.ExtenderConstructor, Path.HintedTypeProvider, Path.Segment, Path.StructuredDataHintingTypeProvider, Path.TypeProvider

Field Summary

Fields inherited from class org.hawkular.inventory.paths.Path

endIdx, path, PATH_DELIM, startIdx, TYPE_DELIM

Method Summary

Modifier and Type	Method and Description
<R,P> R	accept(ElementTypeVisitor<R,P> visitor, P parameter)
Iterator<CanonicalPath>	ascendingIterator()
Iterator<CanonicalPath>	descendingIterator()
CanonicalPath	down() If this path was created by going up from another path, then this method can be used to go back down to the previous paths representing some child resource of the resource represented by this path object.
CanonicalPath	down(int distance) If this path was created by going up from another path, then this method can be used to go back down n steps to the previous paths representing some (grand-)child resource of the resource represented by this path object.
static CanonicalPath.Extender	empty()
CanonicalPath.Extender	extend(SegmentType type, String id) Creates a new path by appending the provided segment to the current path.
static CanonicalPath	fromPartiallyUntypedString(String path, CanonicalPath initialPosition, Class<?> intendedFinalType) An overload of Path.fromPartiallyUntypedString(String, TypeProvider) which uses the provided initial position to figure out the possible type if is missing in the provided relative path.
static CanonicalPath	fromPartiallyUntypedString(String path, CanonicalPath initialPosition, SegmentType intendedFinalType)
static CanonicalPath	fromPartiallyUntypedString(String path, Path.TypeProvider typeProvider)
static CanonicalPath	fromString(String path) Creates a new path instance from the "serialized" slash-separated representation.
CanonicalPath	getLeaf() If this path was created by going up from another path, then this returns the bottom-most path in such chain.
CanonicalPath	getRoot()
CanonicalPath.IdExtractor	ids() The path contains ids of different entities.
boolean	isParentOf(CanonicalPath other)
Iterator<CanonicalPath>	iterator()
CanonicalPath.Extender	modified() The returned extender will produce a modified version of this path.
protected CanonicalPath	newInstance(int startIdx, int endIdx, List<Path.Segment> segments)
static CanonicalPath.Builder	of()
RelativePath	relativeTo(CanonicalPath root)
CanonicalPath	toCanonicalPath() Tries to convert this path to a canonical path.
RelativePath	toRelativePath() Tries to convert this path to a relative path.
String	toString()
CanonicalPath	up() Returns a path corresponding to the direct ancestor of the resource represented by this path object.
CanonicalPath	up(int distance) Returns a path corresponding to the n-th ancestor in the hierarchy.

Methods inherited from class org.hawkular.inventory.paths.Path

equals, fromPartiallyUntypedString, getDepth, getPath, getSegment, getTop, hashCode, isCanonical, isDefined, isParentOf, isRelative

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

empty

public static CanonicalPath.Extender empty()

Returns:

an empty canonical path to be extended

of

public static CanonicalPath.Builder of()

Returns:

a new path builder

fromString

public static CanonicalPath fromString(String path)

Creates a new path instance from the "serialized" slash-separated representation.

The escape character is '\' and special characters are '\', '|' and '/'.

Parameters:

path - the string representation of the path

Returns:

a new path instance

fromPartiallyUntypedString

public static CanonicalPath fromPartiallyUntypedString(String path,
                                                       Path.TypeProvider typeProvider)

Parameters:

path - the canonical path to parse

typeProvider - the type provider used to figure out types of segments that don't explicitly mention it

Returns:

the parsed canonical path

See Also:

Path.fromPartiallyUntypedString(String, TypeProvider)

fromPartiallyUntypedString

public static CanonicalPath fromPartiallyUntypedString(String path,
                                                       CanonicalPath initialPosition,
                                                       Class<?> intendedFinalType)

An overload of Path.fromPartiallyUntypedString(String, TypeProvider) which uses the provided initial position to figure out the possible type if is missing in the provided relative path.

Parameters:

path - the relative path to parse

initialPosition - the initial position using which the types will be deduced for the segments that don't specify the type explicitly

intendedFinalType - the type of the final segment in the path. This can resolve potentially ambiguous situations where, given the initial position, more choices are possible.

Returns:

the parsed relative path

fromPartiallyUntypedString

public static CanonicalPath fromPartiallyUntypedString(String path,
                                                       CanonicalPath initialPosition,
                                                       SegmentType intendedFinalType)

accept

public <R,P> R accept(ElementTypeVisitor<R,P> visitor,
                      P parameter)

toCanonicalPath

public CanonicalPath toCanonicalPath()

Description copied from class: Path

Tries to convert this path to a canonical path. This can result in a new instance construction if this instance is a relative path.

Specified by:

toCanonicalPath in class Path

Returns:

this instance converted to CanonicalPath

toRelativePath

public RelativePath toRelativePath()

Description copied from class: Path

Tries to convert this path to a relative path. This can result in a new instance construction if this instance is a canonical path.

Specified by:

toRelativePath in class Path

Returns:

this instance converted to RelativePath

ascendingIterator

public Iterator<CanonicalPath> ascendingIterator()

Overrides:

ascendingIterator in class Path

Returns:

the iterator that ascends the path from the current segment up to the root

descendingIterator

public Iterator<CanonicalPath> descendingIterator()

Overrides:

descendingIterator in class Path

Returns:

the iterator that descends from the root down to the current segment.

down

public CanonicalPath down()

Description copied from class: Path

If this path was created by going up from another path, then this method can be used to go back down to the previous paths representing some child resource of the resource represented by this path object.

Overrides:

down in class Path

Returns:

a path to a direct child of the resource represented by this path (may be undefined.

down

public CanonicalPath down(int distance)

Description copied from class: Path

If this path was created by going up from another path, then this method can be used to go back down n steps to the previous paths representing some (grand-)child resource of the resource represented by this path object.

Overrides:

down in class Path

Parameters:

distance - the distance from this path to the child path

Returns:

a path to a child of the resource represented by this path (may be undefined.

newInstance

protected CanonicalPath newInstance(int startIdx,
                                    int endIdx,
                                    List<Path.Segment> segments)

Specified by:

newInstance in class Path

up

public CanonicalPath up()

Description copied from class: Path

Returns a path corresponding to the direct ancestor of the resource represented by this path object.

Overrides:

up in class Path

Returns:

the ancestor path (may be undefined.

up

public CanonicalPath up(int distance)

Description copied from class: Path

Returns a path corresponding to the n-th ancestor in the hierarchy.

Overrides:

up in class Path

Parameters:

distance - the distance of the ancestor from the resource represented by this path object.

Returns:

the ancestor path (may be undefined.

getRoot

public CanonicalPath getRoot()

Returns:

The path to the root resource as known to this path instance.

getLeaf

public CanonicalPath getLeaf()

If this path was created by going up from another path, then this returns the bottom-most path in such chain.

Returns:

the bottom-most path in the shared chain

isParentOf

public boolean isParentOf(CanonicalPath other)

relativeTo

public RelativePath relativeTo(CanonicalPath root)

extend

public CanonicalPath.Extender extend(SegmentType type,
                                     String id)

Creates a new path by appending the provided segment to the current path. The returned path does NOT share the chain with the current path anymore.

The returned path will be the leaf path of the new path chain created by obtaining the segments of the current path using Path.getPath() and appending the new segment to it.

It is checked that the new path is a valid canonical path. I.e. you cannot add a tenant segment under a resource, etc.

Parameters:

type - the type of the entity to append

id - the id of the appended entity

Returns:

a new path instance

Throws:

IllegalArgumentException - if adding the provided segment would create an invalid canonical path

modified

public CanonicalPath.Extender modified()

The returned extender will produce a modified version of this path. This path will remain unaffected.

Specified by:

modified in class Path

Returns:

an extender initialized with the current path

ids

public CanonicalPath.IdExtractor ids()

The path contains ids of different entities. I.e. a path to environment always contains the id of the tenant that the environment belongs to.

Using the returned extractor, one can obtain the ids of such different entities easily.

Returns:

the extractor object to use for extracting ids of different entity types from the path.

toString

public String toString()

Overrides:

toString in class Path

iterator

public Iterator<CanonicalPath> iterator()

Specified by:

iterator in interface Iterable<CanonicalPath>