Interface TagPath
-
- All Known Implementing Classes:
AbstractTagPath
,BasicTagPath
,PropertyAlteredTagPath
,SimplifiedTagPath
,SourceAlteredTagPath
public interface TagPath extends java.io.Serializable, java.lang.Comparable<TagPath>, Path
-
-
Field Summary
-
Fields inherited from interface com.inductiveautomation.ignition.common.Path
SERIALIZATION_WHITELIST
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default TagPath
getChildPath(Property<?> property)
Returns the same path with a different property.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.TagPath
getParentPath()
Returns the path to this tag's parent folderProperty<?>
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.java.lang.String
toStringFull()
Returns the full string representation, with source (if any), and property designator (if any)java.lang.String
toStringPartial()
Returns the string representation of the path without the source or the property.-
Methods inherited from interface com.inductiveautomation.ignition.common.Path
getLastPathComponent, getPathComponent, getPathLength, isAncestorOf
-
-
-
-
Method Detail
-
getParentPath
TagPath getParentPath()
Returns the path to this tag's parent folder- Specified by:
getParentPath
in interfacePath
-
getChildPath
TagPath getChildPath(@Nullable java.lang.String nextId)
Returns a path below the current path.
-
getChildPath
default TagPath getChildPath(Property<?> property)
Returns the same path with a different property.
-
getItemName
java.lang.String getItemName()
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.
-
getProperty
@Nullable Property<?> getProperty()
Returns the type of property in the tag that this path is referencing.
-
getSource
java.lang.String getSource()
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.
-
toStringFull
java.lang.String toStringFull()
Returns the full string representation, with source (if any), and property designator (if any)
-
toStringPartial
java.lang.String toStringPartial()
Returns the string representation of the path without the source or the property.
-
-