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, java.io.Serializable, java.lang.Comparable<TagPath>

public class BasicTagPath
extends AbstractTagPath
implements java.io.Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.List<java.lang.String>	EMPTY_LIST
protected TagPath	parent
protected java.util.List<java.lang.String>	pathParts
protected TagProp	prop
protected java.lang.String	source
protected java.lang.String	system

Constructor Summary

Constructors

Constructor and 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, TagProp prop)
BasicTagPath(java.lang.String source, java.lang.String system) Creates a tag path to a source folder
BasicTagPath(java.lang.String source, java.lang.String system, java.util.List<java.lang.String> pathParts) Creates a tag path to a folder
BasicTagPath(java.lang.String source, java.lang.String system, java.util.List<java.lang.String> pathParts, TagProp prop) Creates a tag path to a tag's property

Method Summary

Modifier and Type	Method and Description
static TagPath	append(TagPath root, java.lang.String name) Extends the tag path by the given name.
static TagPath	append(TagPath root, TagPath other) Takes a folder path, and appends the second tag path on to it.
static BasicTagPath	copy(TagPath path)
protected TagPath	createDerivedTagPath(TagPath parent, java.lang.String source, java.lang.String system, java.util.List<java.lang.String> parts, TagProp prop)
TagPath	getChildPath(java.lang.String nextId) Returns a path below the current path.
TagPath	getChildPath(java.lang.String nextId, boolean folder) Deprecated.
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().
TagProp	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	getSystem() Returns which system this tag is being driven by.
boolean	isFolder() Deprecated.
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.

Methods inherited from class com.inductiveautomation.ignition.common.sqltags.model.AbstractTagPath

_createPath, calculateCRC, compareTo, equals, hashCode, isAncestorOf, toString, toStringFull, toStringPartial

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY_LIST

protected static final java.util.List<java.lang.String> EMPTY_LIST

pathParts

protected java.util.List<java.lang.String> pathParts

source

protected java.lang.String source

system

protected java.lang.String system

prop

protected TagProp prop

parent

protected transient TagPath parent

Constructor Detail

BasicTagPath

public BasicTagPath(java.lang.String source,
                    java.util.List<java.lang.String> pathParts,
                    TagProp prop)

BasicTagPath

public BasicTagPath(java.lang.String source,
                    java.lang.String system,
                    java.util.List<java.lang.String> pathParts,
                    TagProp prop)

Creates a tag path to a tag's property

BasicTagPath

public BasicTagPath(java.lang.String source,
                    java.lang.String system,
                    java.util.List<java.lang.String> pathParts)

Creates a tag path to a folder

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,
                    java.lang.String system)

Creates a tag path to a source folder

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

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 interface TagPath

getLastPathComponent

public java.lang.String getLastPathComponent()

Description copied from interface: Path

Convenience function to return the last path element.

Specified by:

getLastPathComponent in interface Path

getParentPath

public TagPath getParentPath()

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)

getProperty

public TagProp getProperty()

Description copied from interface: TagPath

Returns the type of property in the tag that this path is referencing. If this path represents a folder, this will be null. If the path points just to a tag, this will return TagProp.Value (the default property)

Specified by:

getProperty in interface TagPath

isFolder

@Deprecated
public boolean isFolder()

Deprecated.

Description copied from interface: TagPath

Now @deprecated, always returns false. To check the type of object referred to by the path, you must retrieve the actual item.

Specified by:

isFolder in interface TagPath

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.

Specified by:

getSource in interface TagPath

getSystem

public java.lang.String getSystem()

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 java.lang.String getPathComponent(int i)

Description copied from interface: Path

Returns the path element at the specified location.

Specified by:

getPathComponent in interface Path

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 interface Path

getChildPath

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

Deprecated.

Specified by:

getChildPath in interface TagPath

getChildPath

public TagPath getChildPath(java.lang.String nextId)

Description copied from interface: TagPath

Returns a path below the current path.

Specified by:

getChildPath in interface TagPath

createDerivedTagPath

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