Interface UniqueKeyGenerator

All Known Subinterfaces:
UniqueUIKeyGenerator
All Known Implementing Classes:
UniqueKeyGeneratorImpl, UniqueUIKeyGeneratorImpl

public interface UniqueKeyGenerator
Helper class to generate unique UI keys.
  • Method Details

    • generateGroupIdForInstance

      String generateGroupIdForInstance(InstanceModel instance)
      Parameters:
      instance - instance data
      Returns:
      unique key for a UIGroup representing an Instance
    • generateGroupIdForGroup

      String generateGroupIdForGroup(InstanceModel instance, CsticGroup csticModelGroup)
      Parameters:
      instance - instance the group belongs to
      csticModelGroup - group data
      Returns:
      unique key for a UIGroup representing an Group
    • retrieveInstanceId

      String retrieveInstanceId(String uiGroupId)
      Parameters:
      uiGroupId - UIGroup id
      Returns:
      extract instance id from the UIGroup Id
    • retrieveGroupName

      String retrieveGroupName(String uiGroupId)
      Parameters:
      uiGroupId - UIGroup id
      Returns:
      extract group name from the UIGroup Id
    • generateCsticId

      String generateCsticId(CsticModel model, CsticValueModel value, String prefix)
      Generates a Unique Key for a cstic, o a cstic value, if provided.
      Parameters:
      model - cstic model
      value - cstic value model. If null the key is only specific for the cstic
      prefix - key prefix containing group and/or instance components
      Returns:
      unique key
    • splitId

      CsticQualifier splitId(String csticUiKey)
      splits the given cstic UI key into its components
      Parameters:
      csticUiKey -
      Returns:
      a csticQualifier
    • generateId

      String generateId(CsticQualifier csticQualifier)
      creates a cstic ui key from the provided components
      Parameters:
      csticQualifier -
      Returns:
      unique Key
    • extractInstanceNameFromGroupId

      String extractInstanceNameFromGroupId(String groupId)
      Parameters:
      groupId - group id
      Returns:
      extracted instance name from group id
    • getInstanceSeparator

      String getInstanceSeparator()
      Returns:
      the instance separator
    • getKeySeparator

      String getKeySeparator()
      Returns:
      the key separator
    • getKeySeparatorSplit

      String getKeySeparatorSplit()
      Returns:
      the key separator for split statement