Package com.inductiveautomation.ignition.common.tags.tagpaths

Class SimplifiedTagPath

java.lang.Object

com.inductiveautomation.ignition.common.tags.paths.AbstractTagPath

com.inductiveautomation.ignition.common.tags.tagpaths.SimplifiedTagPath

All Implemented Interfaces:

Path, TagPath, Serializable, Comparable<TagPath>

public class SimplifiedTagPath
extends AbstractTagPath

A wrapper around a delegate TagPath that strips the path of its property, for use with managing subscriptions to tags.

See Also:

• Serialized Form

Field Summary

Fields inherited from interface com.inductiveautomation.ignition.common.Path

SERIALIZATION_WHITELIST

Constructor Summary

Constructors

Constructor	Description
SimplifiedTagPath(TagPath delegate)

Method Summary

Modifier and Type	Method	Description
TagPath	getChildPath(String nextId)	Returns a path below the current path.
String	getItemName()	Returns the name of the item at the end of the path that this path points to.
String	getLastPathComponent()	Convenience function to return the last path element.
TagPath	getParentPath()	Returns the path to this tag's parent folder
String	getPathComponent(int i)	Returns the path element at the specified location.
int	getPathLength()	Returns the number of elements in the path, which can be retrieved through getPathComponent().
Property<?>	getProperty()	Returns the type of property in the tag that this path is referencing.
String	getSource()	Returns the source for this tag path.
boolean	isAncestorOf(Path child)	Returns whether the provided path is a child path of this one.

Methods inherited from class com.inductiveautomation.ignition.common.tags.paths.AbstractTagPath

_createPath, compareNullLow, compareTo, equals, hashCode, toString, toStringFull, toStringPartial

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.ignition.common.tags.model.TagPath

getChildPath

Constructor Details

SimplifiedTagPath

public SimplifiedTagPath(TagPath delegate)

Method Details

getProperty

public Property<?> getProperty()

Description copied from interface: TagPath

Returns the type of property in the tag that this path is referencing.

getSource

public String getSource()

Description copied from interface: TagPath

Returns the source for this tag path. Some tag paths don't have a source, indicating that they may be a relative, or they may wish to use a default source.

getChildPath

public TagPath getChildPath(String nextId)

Description copied from interface: TagPath

Returns a path below the current path.

getItemName

public String getItemName()

Description copied from interface: TagPath

Returns the name of the item at the end of the path that this path points to. This will be a tag name or a folder name.

getLastPathComponent

public String getLastPathComponent()

Description copied from interface: Path

Convenience function to return the last path element.

getParentPath

public TagPath getParentPath()

Description copied from interface: TagPath

Returns the path to this tag's parent folder

getPathComponent

public String getPathComponent(int i)

Description copied from interface: Path

Returns the path element at the specified location.

getPathLength

public int getPathLength()

Description copied from interface: Path

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

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

Overrides:

isAncestorOf in class AbstractTagPath