Package com.tibco.ep.tcs.runtime.config

Class IdentificationConfig

  • public final class IdentificationConfig
extends BaseConfig

    A class containing identification metadata for a flow or block.

    • Constructor Detail

      • IdentificationConfig

        public IdentificationConfig()

        Create a new empty identification object.

      • IdentificationConfig

        public IdentificationConfig​(IIdentification source)

        Create a new identification object from the specified interface source.

        Parameters:
        source - source object

      • IdentificationConfig

        public IdentificationConfig​(com.typesafe.config.Config config)

        Create a new identification object from HOCON configuration.

        Parameters:
        config - HOCON representation of the identification

    • Method Detail

      • getUniqueID

        public String getUniqueID()

        Return the identification object's unique identifier.

        Returns:
        unique ID

      • setUniqueID

        public IdentificationConfig setUniqueID​(String uniqueID)

        Set the identification object's unique identifier.

        Parameters:
        uniqueID - unique identifier
        Returns:
        this object

      • getTitle

        public String getTitle()

        Return the identification object's human-readable title, null if none.

        Returns:
        title, null if none

      • setTitle

        public IdentificationConfig setTitle​(String title)

        Set the identification object's title, null if none

        Parameters:
        title - title, null if none
        Returns:
        this object

      • getDescription

        public String getDescription()

        Return the identification object's human-readable description, null if none.

        Returns:
        description, null if none

      • setDescription

        public IdentificationConfig setDescription​(String description)

        Set the identification object's description, null if none

        Parameters:
        description - description, null if none
        Returns:
        this object

      • getAuthor

        public String getAuthor()

        Return the identification object's author, null if none.

        Returns:
        author, null if none

      • setAuthor

        public IdentificationConfig setAuthor​(String author)

        Set the identification object's author, null if none

        Parameters:
        author - author, null if none
        Returns:
        this object

      • getSearchMetaData

        public SearchMetaDataConfig getSearchMetaData()

        Return metadata against which applications can search, null if none.

        Returns:
        search metadata, null if none

      • setSearchMetaData

        public IdentificationConfig setSearchMetaData​(SearchMetaDataConfig searchMetaData)

        Set the identification object's search metadata, null if none.

        Parameters:
        searchMetaData - search metadata, null if none
        Returns:
        this object

      • fillMap

        protected void fillMap​(Map<String,​Object> props)

        Add this object's properties to the specified map.

        Specified by:
        fillMap in class BaseConfig
        Parameters:
        props - map to fill

      • getIDFromConfig

        public static String getIDFromConfig​(com.typesafe.config.Config config)

        Return an ID for the specified HOCON tree, by looking in its uniqueID. If no such ID can be found, return null. Makes no assumptions about validity.

        Parameters:
        config - configuration to check
        Returns:
        desired block ID, null if none found