org.hawkular.inventory.paths

Class RelativePath

java.lang.Object

org.hawkular.inventory.paths.Path

org.hawkular.inventory.paths.RelativePath

All Implemented Interfaces:

Serializable

public final class RelativePath
extends Path
implements Serializable

A relative path is used in the API to refer to other entities during association. Its precise meaning is context-sensitive but the basic idea is that given a position in the graph, you want to refer to other entities that are "near" without needing to provide their full canonical path.

I.e. it is quite usual only associate resources and metrics from a single environment. It would be cumbersome to require the full canonical path for every metric one wants to associate with a resource. Therefore a partial path is used to refer to the metric.

The relative path contains one special segment type - encoded as ".." and represented using the RelativePath.Up class that can be used to go up in the relative 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	RelativePath.Builder
static class	RelativePath.EnvironmentBuilder
static class	RelativePath.Extender
static class	RelativePath.FeedBuilder
static class	RelativePath.MetadataPackBuilder
static class	RelativePath.MetricBuilder
static class	RelativePath.MetricTypeBuilder
static class	RelativePath.OperationTypeBuilder
static class	RelativePath.RelationshipBuilder
static class	RelativePath.ResourceBuilder
static class	RelativePath.ResourceTypeBuilder
static class	RelativePath.StructuredDataBuilder
static class	RelativePath.TenantBuilder
static class	RelativePath.Up
static class	RelativePath.UpBuilder

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
CanonicalPath	applyTo(CanonicalPath path) Applies this relative path on the provided canonical path.
Iterator<RelativePath>	ascendingIterator()
Iterator<RelativePath>	descendingIterator()
RelativePath	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.
RelativePath	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 RelativePath.Extender	empty()
static RelativePath	fromPartiallyUntypedString(String path, CanonicalPath initialPosition, SegmentType 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 RelativePath	fromPartiallyUntypedString(String path, Path.TypeProvider typeProvider)
static RelativePath	fromString(String path)
boolean	isParentOf(RelativePath other)
RelativePath.Extender	modified()
protected Path	newInstance(int startIdx, int endIdx, List<Path.Segment> segments)
RelativePath	slide(int startDelta, int endDelta) Moves the start and end of the path by the provided distances.
static RelativePath.Builder	to()
CanonicalPath	toCanonicalPath() Tries to convert this relative path to a canonical path.
RelativePath	toRelativePath() Tries to convert this path to a relative path.
String	toString()
RelativePath	up() Returns a path corresponding to the direct ancestor of the resource represented by this path object.
RelativePath	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

Method Detail

fromString

public static RelativePath fromString(String path)

fromPartiallyUntypedString

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

Parameters:

path - the relative path to parse

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

Returns:

the parsed relative path

See Also:

Path.fromPartiallyUntypedString(String, TypeProvider)

fromPartiallyUntypedString

public static RelativePath fromPartiallyUntypedString(String path,
                                                      CanonicalPath initialPosition,
                                                      SegmentType 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

empty

public static RelativePath.Extender empty()

Returns:

an empty canonical path to be extended

to

public static RelativePath.Builder to()

newInstance

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

Specified by:

newInstance in class Path

applyTo

public CanonicalPath applyTo(CanonicalPath path)

Applies this relative path on the provided canonical path.

Parameters:

path -

toCanonicalPath

public CanonicalPath toCanonicalPath()

Tries to convert this relative path to a canonical path. This will only succeed if this relative path truly represents a canonical path and thus can be converted to it.

I.e. this will not work on relative paths like ../r;id which doesn't itself represent a full canonical path.

Specified by:

toCanonicalPath in class Path

Returns:

a canonical path constructed from this relative path

Throws:

IllegalArgumentException - if the attempt to convert to canonical path fails

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

modified

public RelativePath.Extender modified()

Specified by:

modified in class Path

Returns:

extender instance to produce an new path instance extending this one

ascendingIterator

public Iterator<RelativePath> ascendingIterator()

Overrides:

ascendingIterator in class Path

Returns:

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

descendingIterator

public Iterator<RelativePath> descendingIterator()

Overrides:

descendingIterator in class Path

Returns:

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

down

public RelativePath 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 RelativePath 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.

up

public RelativePath 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 RelativePath 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.

slide

public RelativePath slide(int startDelta,
                          int endDelta)

Moves the start and end of the path by the provided distances.

Consider the path:

 a/b/c

p1 = p.slide(1, 0) will produce p1 = "b/c", p1.slide(-1, 0) will produce a path equivalent to the original one. p.slide(-1, 0) will produce an undefined path, because it would go past the known start of the path (i.e. beyond "a").

Parameters:

startDelta - the number of steps to move the start of the path

endDelta - the number of steps to move the end of the path

Returns:

a new relative path with modified length and position, possibly undefined

isParentOf

public boolean isParentOf(RelativePath other)

toString

public String toString()

Overrides:

toString in class Path