Interface UniqueUIKeyGenerator

  • All Known Implementing Classes:
    UniqueUIKeyGeneratorImpl

    public interface UniqueUIKeyGenerator
    Helper class to generate unique UI keys.
    • Method Detail

      • generateGroupIdForInstance

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

        java.lang.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

        java.lang.String retrieveInstanceId​(java.lang.String uiGroupId)
        Parameters:
        uiGroupId - UIGroup id
        Returns:
        extract instance id from the UIGroup Id
      • generateCsticId

        java.lang.String generateCsticId​(CsticModel model,
                                         CsticValueModel value,
                                         java.lang.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​(java.lang.String csticUiKey)
        splits the given cstic UI key into its components
        Parameters:
        csticUiKey -
        Returns:
        a csticQualifier
      • generateId

        java.lang.String generateId​(CsticQualifier csticQualifier)
        creates a cstic ui key from the provided components
        Parameters:
        csticQualifier -
        Returns:
        unique Key