com.inductiveautomation.ignition.common

Class QualifiedPath

java.lang.Object

com.inductiveautomation.ignition.common.QualifiedPath

All Implemented Interfaces:

Path, java.io.Serializable

public class QualifiedPath
extends java.lang.Object
implements java.io.Serializable, Path

This class is a path to anything in Ignition, across any system. It dictates how the path is formed, but the actual meaning of different subcomponents will depend on the context in which the path is used.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QualifiedPath.Builder A builder to assist in constructing QualifiedPaths.
static class	QualifiedPath.Part

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	COMPONENTID_SEPERATOR
protected static java.lang.String	PART_SEPERATOR
protected static java.lang.String	SUBPART_SEPERATOR

Constructor Summary

Constructors

Constructor and Description
QualifiedPath()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
QualifiedPath	extend(java.lang.String id, java.lang.String value) Returns a path with the provided component added on.
java.lang.String	getFirstPathComponent()
java.lang.String	getFirstPathComponentId()
java.lang.String	getLastPathComponent() Convenience function to return the last path element.
java.lang.String	getLastPathComponentId()
QualifiedPath	getParentPath()
QualifiedPath.Part	getPart(int i)
protected QualifiedPath.Part[]	getPartsFor(java.lang.String id) Returns all of the sub parts for a specified id, or null if they don't exist.
java.lang.String	getPathComponent(int i) Returns the path element at the specified location.
java.lang.String	getPathComponent(java.lang.String id)
int	getPathLength() Returns the number of elements in the path, which can be retrieved through getPathComponent().
int	hashCode()
boolean	hasPathComponent(java.lang.String id)
protected int	indexOf(java.lang.String id)
boolean	isAncestorOf(Path child) Returns whether the provided path is a child path of this one.
static QualifiedPath	of(java.lang.String... idValPairs) Creates a path out of the specified id/value pairs.
static QualifiedPath	parse(java.lang.String value) Attempts to parse the string into an QualifiedPath.
static QualifiedPath	parseSafe(java.lang.String value) Same as parse(), but catches exceptions and returns null on bad paths.
protected static java.util.List<QualifiedPath.Part>	parseSubParts(java.lang.String id, java.lang.String value) Returns at least one part for the root, with id.
QualifiedPath	replace(java.lang.String id, java.lang.String value) If the component specified by the given id exists in the path, the value will be replaced with the new value.
QualifiedPath	strip() Removes the last fully-qualified component from the path.
QualifiedPath	subpath() Removes the first path component and returns the rest as a new path.
java.lang.String	toString()
java.lang.String	toStringSimple() Returns the path in a friendlier to read form, without component ids.

Methods inherited from class java.lang.Object

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

Field Detail

SUBPART_SEPERATOR

protected static final java.lang.String SUBPART_SEPERATOR

See Also:

Constant Field Values

PART_SEPERATOR

protected static final java.lang.String PART_SEPERATOR

See Also:

Constant Field Values

COMPONENTID_SEPERATOR

protected static final java.lang.String COMPONENTID_SEPERATOR

See Also:

Constant Field Values

Constructor Detail

QualifiedPath

public QualifiedPath()

Method Detail

of

public static QualifiedPath of(java.lang.String... idValPairs)

Creates a path out of the specified id/value pairs. The parameters must be in the form "id,value,id,value".

Parameters:

idValPairs -

Returns:

extend

public QualifiedPath extend(java.lang.String id,
                            java.lang.String value)

Returns a path with the provided component added on.

Parameters:

id -

value -

Returns:

getPathLength

public int getPathLength()

Description copied from interface: Path

Returns the number of elements in the path, which can be retrieved through getPathComponent().

Specified by:

getPathLength in interface Path

Returns:

getPart

@Nullable
public QualifiedPath.Part getPart(int i)

getPathComponent

public java.lang.String getPathComponent(int i)

Description copied from interface: Path

Returns the path element at the specified location.

Specified by:

getPathComponent in interface Path

Returns:

getLastPathComponent

public java.lang.String getLastPathComponent()

Description copied from interface: Path

Convenience function to return the last path element.

Specified by:

getLastPathComponent in interface Path

Returns:

getLastPathComponentId

@Nullable
public java.lang.String getLastPathComponentId()

getFirstPathComponent

public java.lang.String getFirstPathComponent()

getFirstPathComponentId

public java.lang.String getFirstPathComponentId()

subpath

public QualifiedPath subpath()

Removes the first path component and returns the rest as a new path.

strip

public QualifiedPath strip()

Removes the last fully-qualified component from the path. This differs from getParentPath() in that that function doesn't care whether the component is qualified or not.

Returns:

replace

public QualifiedPath replace(java.lang.String id,
                             java.lang.String value)

If the component specified by the given id exists in the path, the value will be replaced with the new value.

indexOf

protected int indexOf(java.lang.String id)

getPathComponent

@Nullable
public java.lang.String getPathComponent(@Nullable
                                                   java.lang.String id)

getPartsFor

@Nullable
protected QualifiedPath.Part[] getPartsFor(@Nullable
                                                     java.lang.String id)

Returns all of the sub parts for a specified id, or null if they don't exist.

Parameters:

id -

Returns:

hasPathComponent

public boolean hasPathComponent(java.lang.String id)

getParentPath

public QualifiedPath getParentPath()

toString

@Nonnull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toStringSimple

@Nonnull
public java.lang.String toStringSimple()

Returns the path in a friendlier to read form, without component ids.

Returns:

isAncestorOf

public boolean isAncestorOf(Path child)

Description copied from interface: Path

Returns whether the provided path is a child path of this one.

Specified by:

isAncestorOf in interface Path

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

parse

public static QualifiedPath parse(java.lang.String value)
                           throws java.io.IOException

Attempts to parse the string into an QualifiedPath. IOException is thrown on invalid path.

Throws:

java.io.IOException

parseSafe

public static QualifiedPath parseSafe(java.lang.String value)

Same as parse(), but catches exceptions and returns null on bad paths.

parseSubParts

protected static java.util.List<QualifiedPath.Part> parseSubParts(java.lang.String id,
                                                                  java.lang.String value)

Returns at least one part for the root, with id. If the value contains sub parts, those will be returned as well. The root part will have the sub part count set on it already.

Parameters:

id -

value -

Returns: