Class DataKeyUtils
- java.lang.Object
-
- com.inductiveautomation.reporting.common.util.DataKeyUtils
-
public class DataKeyUtils extends java.lang.Object
A utility class to help manage DataKey functionality in Ignition Reporting. Copyright Inductive Automation 2015 Project: Reporting- Since:
- 7.8.1
-
-
Constructor Summary
Constructors Constructor Description DataKeyUtils()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static java.lang.String
getKey(java.lang.String key)
Helper method to add @ if needed and massage Page of Pagemaxstatic java.lang.String
getRelativizedKey(RMShape shape, java.lang.String key)
If the RMShape parameter is a child of a parent shape, this method will return a path that is relativized to the parent shape.static java.lang.String
getSelectedDataKey()
-
-
-
Method Detail
-
getSelectedDataKey
@Nullable public static java.lang.String getSelectedDataKey()
-
getRelativizedKey
@Nonnull public static java.lang.String getRelativizedKey(RMShape shape, java.lang.String key)
If the RMShape parameter is a child of a parent shape, this method will return a path that is relativized to the parent shape. This method is convenient in situations such as drag-and-drop onto a RMTextShape field which is inside a parent such as a table. If the parent has a Data key of "ADataSource" and a datakey from the source named "ADataSource.idString" is dropped on the child TextShape, this method will return "idString" when passed the child TextShape and the key.- Parameters:
shape
- the shape we are trying to get the relative key for.key
- the full data key, of which our relative key should be a part of.- Returns:
- the relativized key, if there is a relation found, otherwise will return the original Key or empty string
- Since:
- 7.8.1
-
getKey
public static java.lang.String getKey(java.lang.String key)
Helper method to add @ if needed and massage Page of Pagemax
-
-