Package com.inductiveautomation.ignition.common

Class QualifiedPathUtils

java.lang.Object
com.inductiveautomation.ignition.common.QualifiedPathUtils
public class QualifiedPathUtils extends Object
This class provides utilities related to QualifiedPaths. Primarily it provides conversion to and from other path types, like TagPath.

  • Constructor Details

    • QualifiedPathUtils

      public QualifiedPathUtils()

  • Method Details

    • 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(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 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(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(String historicalPath, String defaultHistoryProvider, String defaultSystem, String defaultTagProvider)
      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.

    • toPathFromTagString

      public static QualifiedPath toPathFromTagString(String tagPath, String defaultHistoryProvider, String defaultSystem, String defaultTagProvider)

    • toPathFromStringPath

      public static QualifiedPath toPathFromStringPath(String stringPath, String defaultHistoryProvider, String defaultSystem, String defaultTagProvider, boolean isHistoricalPathSyntax)

    • 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(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)

    • isQualifiedHistorianProviderPath

      public static boolean isQualifiedHistorianProviderPath(QualifiedPath qp)

    • systemSchemaFromDriverSchema

      public static QualifiedPath systemSchemaFromDriverSchema(String driverSchemaData, Supplier<String> systemNameSupplier, String defaultProvider)

    • isModerHistorianPath

      public static boolean isModerHistorianPath(QualifiedPath path)

    • toModernHistoricalPath

      public static QualifiedPath toModernHistoricalPath(QualifiedPath path)