Package com.inductiveautomation.ignition.common.tags.model

Interface TagPath

All Superinterfaces:
Comparable<TagPath>, Path, Serializable
All Known Implementing Classes:
AbstractTagPath, BasicTagPath, PropertyAlteredTagPath, SimplifiedTagPath, SourceAlteredTagPath
public interface TagPath extends Serializable, Comparable<TagPath>, Path

  • Method Details

    • getParentPath

      TagPath getParentPath()
      Returns the path to this tag's parent folder
      Specified by:
      getParentPath in interface Path

    • getChildPath

      TagPath getChildPath(@Nullable String nextId)
      Returns a path below the current path.

    • getChildPath

      default TagPath getChildPath(Property<?> property)
      Returns the same path with a different property.

    • getItemName

      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

      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

      String toStringFull()
      Returns the full string representation, with source (if any), and property designator (if any)

    • toStringPartial

      String toStringPartial()
      Returns the string representation of the path without the source or the property.