Class BasicTagPath
- java.lang.Object
-
- com.inductiveautomation.ignition.common.tags.paths.AbstractTagPath
-
- com.inductiveautomation.ignition.common.tags.paths.BasicTagPath
-
public class BasicTagPath extends AbstractTagPath implements java.io.Serializable
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description BasicTagPath(java.lang.String source)
BasicTagPath(java.lang.String source, java.util.List<java.lang.String> pathParts)
Creates a tag path to a folder.BasicTagPath(java.lang.String source, java.util.List<java.lang.String> pathParts, Property<?> prop)
Creates a tag path to a tag's property
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static TagPath
append(TagPath root, TagPath other)
Takes a folder path, and appends the second tag path on to it.static TagPath
append(TagPath root, java.lang.String name)
Extends the tag path by the given name.static BasicTagPath
copy(TagPath path)
protected TagPath
createDerivedTagPath(TagPath parent, java.lang.String source, java.util.List<java.lang.String> parts, Property<?> prop)
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 the 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.static BasicTagPath
renameParentFolder(TagPath path, TagPath newParent)
Creates a path equal to the original, but with the new name specified by newParent.protected void
setParent(TagPath value)
protected void
setPathParts(java.util.List<java.lang.String> parts)
static BasicTagPath
subPath(TagPath path, int start, int len)
Returns a sub portion of the path.static BasicTagPath
subPath(TagPath parent, TagPath child)
Returns a sub portion of the child path that extends beyond the parent 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
-
BasicTagPath
public BasicTagPath(java.lang.String source, java.util.List<java.lang.String> pathParts, Property<?> prop)
Creates a tag path to a tag's property
-
BasicTagPath
public BasicTagPath(java.lang.String source, java.util.List<java.lang.String> pathParts)
Creates a tag path to a folder. System will be null.
-
BasicTagPath
public BasicTagPath(java.lang.String source)
-
-
Method Detail
-
renameParentFolder
public static BasicTagPath renameParentFolder(TagPath path, TagPath newParent)
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(@Nullable TagPath root, TagPath other)
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, java.lang.String name)
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)
-
subPath
public static BasicTagPath subPath(TagPath path, int start, int len)
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. Does NOT include the source, because this is now intended to be a relative path to the original one.
-
subPath
public static BasicTagPath subPath(TagPath parent, TagPath child)
Returns a sub portion of the child path that extends beyond the parent path. Source will be empty, and the property will only be included if set on the child.
-
setPathParts
protected void setPathParts(java.util.List<java.lang.String> parts)
-
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.- Specified by:
getItemName
in interfaceTagPath
-
getLastPathComponent
public java.lang.String getLastPathComponent()
Description copied from interface:Path
Convenience function to return the last path element.- Specified by:
getLastPathComponent
in interfacePath
-
getParentPath
public TagPath getParentPath()
Returns the path to the parent folder.- Specified by:
getParentPath
in interfacePath
- Specified by:
getParentPath
in interfaceTagPath
-
setParent
protected void setParent(TagPath value)
-
getProperty
public Property<?> getProperty()
Description copied from interface:TagPath
Returns the type of property in the tag that this path is referencing.- Specified by:
getProperty
in interfaceTagPath
-
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.
-
getPathComponent
public java.lang.String getPathComponent(int i)
Description copied from interface:Path
Returns the path element at the specified location.- Specified by:
getPathComponent
in interfacePath
-
getPathLength
public int getPathLength()
Description copied from interface:Path
Returns the number of elements in the path, which can be retrieved through getPathComponent().- Specified by:
getPathLength
in interfacePath
-
getChildPath
public TagPath getChildPath(java.lang.String nextId)
Description copied from interface:TagPath
Returns a path below the current path.- Specified by:
getChildPath
in interfaceTagPath
-
-