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

Class SimplifiedTagPath

  • All Implemented Interfaces:
    Path, TagPath, java.io.Serializable, java.lang.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

    • Constructor Detail

      • SimplifiedTagPath

        public SimplifiedTagPath​(TagPath delegate)

    • Method Detail

      • 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.

      • 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().

      • 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