Package com.evolveum.midpoint.prism.impl.path

Class UniformItemPathImpl

java.lang.Object

com.evolveum.midpoint.prism.impl.path.UniformItemPathImpl

All Implemented Interfaces:

ItemPath, UniformItemPath, ShortDumpable, Serializable, Cloneable

public class UniformItemPathImpl
extends Object
implements UniformItemPath

Author:

semancik

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.path.ItemPath

ItemPath.CompareResult

Field Summary

Fields

Modifier and Type	Field	Description
static UniformItemPathImpl	EMPTY_PATH

Constructor Summary

Constructors

Constructor	Description
UniformItemPathImpl(ItemPath itemPath)
UniformItemPathImpl(ItemPathSegment... segments)
UniformItemPathImpl(UniformItemPath parentPath, ItemPathSegment subSegment)
UniformItemPathImpl(UniformItemPath parentPath, UniformItemPath childPath)
UniformItemPathImpl(UniformItemPath parentPath, QName subName)
UniformItemPathImpl(Object... namesOrIdsOrSegments)
UniformItemPathImpl(String... names)
UniformItemPathImpl(List<ItemPathSegment> segments)
UniformItemPathImpl(List<ItemPathSegment> segments, ItemPathSegment subSegment)
UniformItemPathImpl(List<ItemPathSegment> segments, List<ItemPathSegment> additionalSegments)
UniformItemPathImpl(List<ItemPathSegment> segments, QName subName)
UniformItemPathImpl(QName... qnames)

Method Summary

Modifier and Type	Method	Description
UniformItemPath	allExceptLast()	Returns a path containing all segments except the last one.
UniformItemPath	allUpToIncluding(int i)	Returns all segments up to the specified one (including it).
UniformItemPath	allUpToLastName()	Returns a path containing all segments up to (and not including) the last one.
UniformItemPath	append(ItemPathSegment subSegment)
UniformItemPath	append(UniformItemPath subPath)
UniformItemPath	append(Long id)
UniformItemPath	append(Object... components)	Returns a newly created path containing all the segments of this path with added components.
UniformItemPath	append(QName childName)
ItemPathType	asItemPathType()
UniformItemPath	clone()
static ItemPathSegment	createSegment(QName qname, boolean variable)
boolean	equals(Object obj)	More strict version of ItemPath comparison.
ItemPathSegment	first()	Returns the first segment or null if the path is empty.
UniformItemPath	firstAsPath()	Returns first segment in a form of path.
static UniformItemPathImpl	fromItemPath(ItemPath itemPath)
Map<String,String>	getNamespaceMap()
ItemPathSegment	getSegment(int i)	Returns the given path segment.
List<ItemPathSegment>	getSegments()	Returns the path segments.
int	hashCode()
boolean	isEmpty()	Returns true if the path is empty i.e.
ItemPathSegment	last()	Returns the last segment (or null if the path is empty).
ItemName	lastName()	Returns the last name segment value; or null if there's no name segment.
UniformItemPath	namedSegmentsOnly()	Returns the path containing only the regular named segments.
UniformItemPathImpl	normalize()	Makes the path "normal" by inserting null Id segments where they were omitted.
UniformItemPath	remainder(ItemPath prefix)	Returns the remainder of "this" path after passing all segments from the other path.
UniformItemPath	removeIds()	Returns the path with no Id segments.
UniformItemPath	rest()	Returns the rest of the path (the tail).
UniformItemPath	rest(int n)	Returns the rest of the path (the tail), starting at position "n".
void	setNamespaceMap(Map<String,String> namespaceMap)
int	size()	Returns path size i.e.
UniformItemPath	stripVariableSegment()	Removes the leading variable segment, if present.
UniformItemPathImpl	subPath(int from, int to)	Returns a sub-path from (including) to (excluding) given indices.
UniformItemPath	tail(int n)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.evolveum.midpoint.prism.path.ItemPath

asSingleName, asSingleNameOrFail, compareComplex, containsNameExactly, containsSpecialSymbols, containsSpecialSymbolsExceptParent, equals, equivalent, firstName, firstNameIndex, firstNameOrFail, firstToId, firstToIdOrNull, firstToName, firstToNameOrNull, firstToVariableNameOrNull, isSingleName, isSubPath, isSubPathOrEquivalent, isSuperPath, isSuperPathOrEquivalent, lastNameIndex, shortDump, startsWith, startsWithId, startsWithIdentifier, startsWithName, startsWithName, startsWithNullId, startsWithObjectReference, startsWithParent, startsWithVariable

Methods inherited from interface com.evolveum.midpoint.util.ShortDumpable

shortDump, shortDumpLazily

Field Detail

EMPTY_PATH

public static final UniformItemPathImpl EMPTY_PATH

Constructor Detail

UniformItemPathImpl

public UniformItemPathImpl(QName... qnames)

UniformItemPathImpl

public UniformItemPathImpl(String... names)

UniformItemPathImpl

public UniformItemPathImpl(@NotNull
                           ItemPath itemPath)

UniformItemPathImpl

public UniformItemPathImpl(Object... namesOrIdsOrSegments)

UniformItemPathImpl

public UniformItemPathImpl(UniformItemPath parentPath,
                           QName subName)

UniformItemPathImpl

public UniformItemPathImpl(UniformItemPath parentPath,
                           UniformItemPath childPath)

UniformItemPathImpl

public UniformItemPathImpl(List<ItemPathSegment> segments)

UniformItemPathImpl

public UniformItemPathImpl(List<ItemPathSegment> segments,
                           ItemPathSegment subSegment)

UniformItemPathImpl

public UniformItemPathImpl(List<ItemPathSegment> segments,
                           QName subName)

UniformItemPathImpl

public UniformItemPathImpl(List<ItemPathSegment> segments,
                           List<ItemPathSegment> additionalSegments)

UniformItemPathImpl

public UniformItemPathImpl(ItemPathSegment... segments)

UniformItemPathImpl

public UniformItemPathImpl(UniformItemPath parentPath,
                           ItemPathSegment subSegment)

Method Detail

fromItemPath

@NotNull
public static UniformItemPathImpl fromItemPath(ItemPath itemPath)

createSegment

public static ItemPathSegment createSegment(QName qname,
                                            boolean variable)

setNamespaceMap

public void setNamespaceMap(Map<String,String> namespaceMap)

Specified by:

setNamespaceMap in interface UniformItemPath

getNamespaceMap

public Map<String,String> getNamespaceMap()

Specified by:

getNamespaceMap in interface UniformItemPath

append

@NotNull
public UniformItemPath append(Object... components)

Description copied from interface: ItemPath

Returns a newly created path containing all the segments of this path with added components.

Specified by:

append in interface ItemPath

Specified by:

append in interface UniformItemPath

append

public UniformItemPath append(Long id)

append

public UniformItemPath append(ItemPathSegment subSegment)

append

public UniformItemPath append(UniformItemPath subPath)

getSegments

@NotNull
public List<ItemPathSegment> getSegments()

Description copied from interface: ItemPath

Returns the path segments. Avoid using this method and access segments directly. Instead try to find suitable method in ItemPath interface. NEVER change path content using this method. TODO consider returning unmodifiable collection here (beware of performance implications)

Specified by:

getSegments in interface ItemPath

Specified by:

getSegments in interface UniformItemPath

first

public ItemPathSegment first()

Description copied from interface: ItemPath

Returns the first segment or null if the path is empty.

Specified by:

first in interface ItemPath

Specified by:

first in interface UniformItemPath

rest

@NotNull
public UniformItemPath rest()

Description copied from interface: ItemPath

Returns the rest of the path (the tail).

Specified by:

rest in interface ItemPath

Specified by:

rest in interface UniformItemPath

rest

@NotNull
public UniformItemPath rest(int n)

Description copied from interface: ItemPath

Returns the rest of the path (the tail), starting at position "n".

Specified by:

rest in interface ItemPath

Specified by:

rest in interface UniformItemPath

tail

@NotNull
public UniformItemPath tail(int n)

last

@Nullable
public ItemPathSegment last()

Description copied from interface: ItemPath

Returns the last segment (or null if the path is empty).

Specified by:

last in interface ItemPath

Specified by:

last in interface UniformItemPath

firstAsPath

public UniformItemPath firstAsPath()

Description copied from interface: UniformItemPath

Returns first segment in a form of path.

Specified by:

firstAsPath in interface ItemPath

Specified by:

firstAsPath in interface UniformItemPath

allExceptLast

@NotNull
public UniformItemPath allExceptLast()

Description copied from interface: UniformItemPath

Returns a path containing all segments except the last one.

Specified by:

allExceptLast in interface ItemPath

Specified by:

allExceptLast in interface UniformItemPath

allUpToLastName

@NotNull
public UniformItemPath allUpToLastName()

Description copied from interface: UniformItemPath

Returns a path containing all segments up to (and not including) the last one.

Specified by:

allUpToLastName in interface ItemPath

Specified by:

allUpToLastName in interface UniformItemPath

allUpToIncluding

public UniformItemPath allUpToIncluding(int i)

Description copied from interface: ItemPath

Returns all segments up to the specified one (including it).

Specified by:

allUpToIncluding in interface ItemPath

Specified by:

allUpToIncluding in interface UniformItemPath

size

public int size()

Description copied from interface: ItemPath

Returns path size i.e. the number of components.

Specified by:

size in interface ItemPath

isEmpty

public boolean isEmpty()

Description copied from interface: ItemPath

Returns true if the path is empty i.e. has no components.

Specified by:

isEmpty in interface ItemPath

normalize

public UniformItemPathImpl normalize()

Makes the path "normal" by inserting null Id segments where they were omitted.

Specified by:

normalize in interface UniformItemPath

removeIds

@NotNull
public UniformItemPath removeIds()

Description copied from interface: ItemPath

Returns the path with no Id segments.

Specified by:

removeIds in interface ItemPath

Specified by:

removeIds in interface UniformItemPath

namedSegmentsOnly

@NotNull
public UniformItemPath namedSegmentsOnly()

Description copied from interface: ItemPath

Returns the path containing only the regular named segments.

Specified by:

namedSegmentsOnly in interface ItemPath

Specified by:

namedSegmentsOnly in interface UniformItemPath

stripVariableSegment

@NotNull
public UniformItemPath stripVariableSegment()

Description copied from interface: ItemPath

Removes the leading variable segment, if present.

Specified by:

stripVariableSegment in interface ItemPath

Specified by:

stripVariableSegment in interface UniformItemPath

append

public UniformItemPath append(QName childName)

remainder

public UniformItemPath remainder(ItemPath prefix)

Description copied from interface: ItemPath

Returns the remainder of "this" path after passing all segments from the other path. (I.e. this path must begin with the content of the other path. Throws an exception when it is not the case.)

Specified by:

remainder in interface ItemPath

Specified by:

remainder in interface UniformItemPath

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

More strict version of ItemPath comparison. Does not use any normalization nor approximate matching QNames via QNameUtil.match. For semantic-level comparison, please use equivalent(..) method.

Specified by:

equals in interface UniformItemPath

Overrides:

equals in class Object

clone

public UniformItemPath clone()

Specified by:

clone in interface UniformItemPath

Overrides:

clone in class Object

asItemPathType

public ItemPathType asItemPathType()

Specified by:

asItemPathType in interface UniformItemPath

lastName

public ItemName lastName()

Description copied from interface: ItemPath

Returns the last name segment value; or null if there's no name segment.

Specified by:

lastName in interface ItemPath

subPath

public UniformItemPathImpl subPath(int from,
                                   int to)

Description copied from interface: ItemPath

Returns a sub-path from (including) to (excluding) given indices.

Specified by:

subPath in interface ItemPath

getSegment

public ItemPathSegment getSegment(int i)

Description copied from interface: ItemPath

Returns the given path segment.

Specified by:

getSegment in interface ItemPath

Specified by:

getSegment in interface UniformItemPath

toString

public String toString()

Overrides:

toString in class Object