com.inductiveautomation.ignition.common.tags.paths

Class PropertyAlteredTagPath

java.lang.Object

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

com.inductiveautomation.ignition.common.tags.paths.PropertyAlteredTagPath

All Implemented Interfaces:

Path, TagPath, java.io.Serializable, java.lang.Comparable<TagPath>

public class PropertyAlteredTagPath
extends AbstractTagPath

A tag path that delegates to another tag path, but alters the TagProp that the path points to.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PropertyAlteredTagPath(TagPath path, Property<?> prop)

Method Summary

Modifier and Type	Method and Description
TagPath	getChildPath(java.lang.String nextId) Returns a path below the current path.
java.lang.String	getItemName() Returns the name of the item at the end of the path that this path points to.
java.lang.String	getLastPathComponent() Convenience function to return the last path element.
TagPath	getParentPath() Returns the path to this tag's parent folder
java.lang.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.
java.lang.String	getSource() Returns the source for this tag path.

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

_createPath, compareNullLow, compareTo, equals, hashCode, isAncestorOf, 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 Detail

PropertyAlteredTagPath

public PropertyAlteredTagPath(TagPath path,
                              Property<?> prop)

Method Detail

getChildPath

public TagPath getChildPath(java.lang.String nextId)

Description copied from interface: TagPath

Returns a path below the current path.

getItemName

public java.lang.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 java.lang.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 java.lang.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().

getProperty

public Property<?> getProperty()

Description copied from interface: TagPath

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

getSource

public java.lang.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.