Package com.inductiveautomation.ignition.common.sqltags.parser

Class BasicTagPath

java.lang.Object
com.inductiveautomation.ignition.common.sqltags.model.AbstractTagPath
com.inductiveautomation.ignition.common.sqltags.parser.BasicTagPath
All Implemented Interfaces:
Path, TagPath, Serializable, Comparable<TagPath>
@Deprecated public class BasicTagPath extends AbstractTagPath implements Serializable
Deprecated.
See Also:

  • Field Details

    • EMPTY_LIST

      protected static final List<String> EMPTY_LIST
      Deprecated.

    • pathParts

      protected List<String> pathParts
      Deprecated.

    • source

      protected String source
      Deprecated.

    • system

      protected String system
      Deprecated.

    • prop

      protected TagProp prop
      Deprecated.

    • parent

      protected transient TagPath parent
      Deprecated.

  • Constructor Details

    • BasicTagPath

      public BasicTagPath(String source, List<String> pathParts, TagProp prop)
      Deprecated.

    • BasicTagPath

      public BasicTagPath(String source, String system, List<String> pathParts, TagProp prop)
      Deprecated.
      Creates a tag path to a tag's property

    • BasicTagPath

      public BasicTagPath(String source, String system, List<String> pathParts)
      Deprecated.
      Creates a tag path to a folder

    • BasicTagPath

      public BasicTagPath(String source, List<String> pathParts)
      Deprecated.
      Creates a tag path to a folder. System will be null.

    • BasicTagPath

      public BasicTagPath(String source, String system)
      Deprecated.
      Creates a tag path to a source folder

    • BasicTagPath

      public BasicTagPath(String source)
      Deprecated.

  • Method Details

    • renameParentFolder

      public static BasicTagPath renameParentFolder(TagPath path, TagPath newParent)
      Deprecated.
      Creates a path equal to the original, but with the new name specified by newParent. The parent cannot change length, it can only be renamed.

    • append

      public static TagPath append(TagPath root, TagPath other)
      Deprecated.
      Takes a folder path, and appends the second tag path on to it. The returned tag will have the source and system of the root path, unless the root path source/system are null (not just empty string).

    • append

      public static TagPath append(TagPath root, String name)
      Deprecated.
      Extends the tag path by the given name. Similar to getChildPath, however this static version will accept a null value for parent, and will generate a new path with just the name if necessary.

    • copy

      public static BasicTagPath copy(TagPath path)
      Deprecated.

    • subPath

      public static BasicTagPath subPath(TagPath path, int start, int len)
      Deprecated.
      Returns a sub portion of the path. If the specified length covers the last component, the source path's property will be included in the resulting path as well.

    • setPathParts

      protected void setPathParts(List<String> parts)
      Deprecated.

    • getItemName

      public String getItemName()
      Deprecated.
      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.
      Specified by:
      getItemName in interface TagPath

    • getLastPathComponent

      public String getLastPathComponent()
      Deprecated.
      Description copied from interface: Path
      Convenience function to return the last path element.
      Specified by:
      getLastPathComponent in interface Path

    • getParentPath

      public TagPath getParentPath()
      Deprecated.
      Returns the path to the parent folder.
      Specified by:
      getParentPath in interface Path
      Specified by:
      getParentPath in interface TagPath

    • setParent

      protected void setParent(TagPath value)
      Deprecated.

    • getProperty

      public TagProp getProperty()
      Deprecated.
      Description copied from interface: TagPath
      Returns the type of property in the tag that this path is referencing.
      Specified by:
      getProperty in interface TagPath

    • isFolder

      @Deprecated public boolean isFolder()
      Deprecated.

    • getSource

      public String getSource()
      Deprecated.
      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.
      Specified by:
      getSource in interface TagPath

    • getSystem

      public String getSystem()
      Deprecated.
      Description copied from interface: TagPath
      Returns which system this tag is being driven by. If null, the system name won't be used to distinguish tags.
      Specified by:
      getSystem in interface TagPath

    • getPathComponent

      public String getPathComponent(int i)
      Deprecated.
      Description copied from interface: Path
      Returns the path element at the specified location.
      Specified by:
      getPathComponent in interface Path

    • getPathLength

      public int getPathLength()
      Deprecated.
      Description copied from interface: Path
      Returns the number of elements in the path, which can be retrieved through getPathComponent().
      Specified by:
      getPathLength in interface Path

    • getChildPath

      @Deprecated public TagPath getChildPath(String nextId, boolean folder)
      Deprecated.

    • getChildPath

      public TagPath getChildPath(String nextId)
      Deprecated.
      Description copied from interface: TagPath
      Returns a path below the current path.
      Specified by:
      getChildPath in interface TagPath

    • createDerivedTagPath

      protected TagPath createDerivedTagPath(TagPath parent, String source, String system, List<String> parts, TagProp prop)
      Deprecated.