com.inductiveautomation.ignition.common

Class TagPathUtils

java.lang.Object

com.inductiveautomation.ignition.common.TagPathUtils

public class TagPathUtils
extends java.lang.Object

Created by colby.clegg on 7/14/2015.

Constructor Summary

Constructors

Constructor and Description
TagPathUtils()

Method Summary

Modifier and Type	Method and Description
static ArrayIndex	getArrayIndex(TagPath path) Returns the array index contained in the tag, or null if it's not an array path.
static TagPath	getNonArrayPath(TagPath path) Given a path, returns a version that does not include array subset information.
static boolean	isArrayPath(TagPath path)
static java.lang.String	sanitizeName(java.lang.String tagName) This function removes any characters from a tag name that might cause problems as part of a full path.
static TagPath	wrap(TagPath path, java.lang.String source) Potentially returns a modified tag path that has the default datasource name explicitly defined

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TagPathUtils

public TagPathUtils()

Method Detail

getNonArrayPath

public static TagPath getNonArrayPath(TagPath path)

Given a path, returns a version that does not include array subset information. Works fine if the source path is not an array path to begin with.

isArrayPath

public static boolean isArrayPath(TagPath path)

getArrayIndex

public static ArrayIndex getArrayIndex(TagPath path)

Returns the array index contained in the tag, or null if it's not an array path.

sanitizeName

public static java.lang.String sanitizeName(java.lang.String tagName)

This function removes any characters from a tag name that might cause problems as part of a full path.

wrap

public static TagPath wrap(TagPath path,
                           java.lang.String source)
                    throws java.lang.IllegalArgumentException

Potentially returns a modified tag path that has the default datasource name explicitly defined

Throws:

java.lang.IllegalArgumentException