Package com.inductiveautomation.ignition.common

Class QualifiedPathUtils

java.lang.Object

com.inductiveautomation.ignition.common.QualifiedPathUtils

public class QualifiedPathUtils
extends java.lang.Object

This class provides utilities related to QualifiedPaths. Primarily it provides conversion to and from other path types, like TagPath.

Constructor Summary

Constructors

Constructor	Description
QualifiedPathUtils()

Method Summary

Modifier and Type	Method	Description
static QualifiedPath	fromHistoricalTagPath(TagPath path)	Deprecated.
static QualifiedPath	fromHistoricalTagPathNew(TagPath path)
static QualifiedPath	fromTagPath(TagPath path)	Deprecated.
static QualifiedPath	fromTagPathNew(TagPath path)
static QualifiedPath	parsePossibleTagpath(java.lang.String value)	Deprecated.
static QualifiedPath	parsePossibleTagpathNew(java.lang.String value)	This function parses an QualifiedPath, but if that fails, attempts to parse it as a tag path and convert it.
static QualifiedPath	toPathFromHistoricalString(java.lang.String histPath)	This is a transitional helper function which is the opposite of toStringFromHistoricalPath().
static QualifiedPath	toPathFromHistoricalString(java.lang.String histPath, java.lang.String defaultHistProvider, java.lang.String defaultSystem, java.lang.String defaultProv)	This is the opposite of toStringFromHistoricalPath.
static java.lang.String	toStringFromHistoricalPath(QualifiedPath path)	This is a helper function, as we transition to qualifiedpaths, to convert from a path indicating a historical path to a string, for display and edit.
static TagPath	toTagPath(QualifiedPath path)	Deprecated.
static TagPath	toTagPathNew(QualifiedPath path)	Attempts to create a tag path out of the provided qualified path.

Methods inherited from class java.lang.Object

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

Constructor Detail

QualifiedPathUtils

public QualifiedPathUtils()

Method Detail

fromTagPath

@Deprecated
public static QualifiedPath fromTagPath(TagPath path)

Deprecated.

fromHistoricalTagPath

@Deprecated
public static QualifiedPath fromHistoricalTagPath(TagPath path)

Deprecated.

toTagPath

@Deprecated
public static TagPath toTagPath(QualifiedPath path)

Deprecated.

Attempts to create a tag path out of the provided qualified path. If no "prov" or "tag" component is found, returns null.

parsePossibleTagpath

@Deprecated
public static QualifiedPath parsePossibleTagpath(java.lang.String value)

Deprecated.

This function parses an QualifiedPath, but if that fails, attempts to parse it as a tag path and convert it.

toStringFromHistoricalPath

public static java.lang.String toStringFromHistoricalPath(QualifiedPath path)

This is a helper function, as we transition to qualifiedpaths, to convert from a path indicating a historical path to a string, for display and edit. It renders strings in the form of: [histprov/drv]tag if it's a historical tag path, or returns the qualified path.

toPathFromHistoricalString

public static QualifiedPath toPathFromHistoricalString(java.lang.String histPath)

This is a transitional helper function which is the opposite of toStringFromHistoricalPath(). It takes a historical path, rendered as a string, and reconstitutes it into a QualifiedPath.

toPathFromHistoricalString

public static QualifiedPath toPathFromHistoricalString(java.lang.String histPath,
                                                       java.lang.String defaultHistProvider,
                                                       java.lang.String defaultSystem,
                                                       java.lang.String defaultProv)

This is the opposite of toStringFromHistoricalPath. It takes a string, which usually represents a tag path, and turns it into a qualifiedpath that can be used to query history. It has support for replacing default values for history provider, system, and tag provider.

toTagPathNew

public static TagPath toTagPathNew(QualifiedPath path)

Attempts to create a tag path out of the provided qualified path. If no "prov" or "tag" component is found, returns null.

parsePossibleTagpathNew

public static QualifiedPath parsePossibleTagpathNew(java.lang.String value)

This function parses an QualifiedPath, but if that fails, attempts to parse it as a tag path and convert it.

fromTagPathNew

public static QualifiedPath fromTagPathNew(TagPath path)

fromHistoricalTagPathNew

public static QualifiedPath fromHistoricalTagPathNew(TagPath path)