Package com.denodo.configuration.metadata

Class MetaParameter

java.lang.Object
com.denodo.configuration.metadata.MetaParameter
All Implemented Interfaces:
Serializable
public class MetaParameter extends Object implements Serializable
MetaParameter encapsulates the meta-information of a parameter required by a specific Custom Element.
See Also:

  • Field Details

    • serialVersionUID

      protected static final long serialVersionUID
      For interoperability with possible future changes.
      See Also:

  • Constructor Details

    • MetaParameter

      public MetaParameter()
      Creates an empty MetaParameter.

    • MetaParameter

      public MetaParameter(String name, boolean multivalued, boolean mandatory, Class<?> javaType, boolean hidden, boolean auditable, String reference, Collection<MetaParameter> components)
      Creates a MetaParameter.
      Parameters:
      name - the name.
      multivalued - the multivalued attribute. true specifies a parameter which can hold multiple values.
      mandatory -
      javaType - the java type for the values that hold the parameter represented by this meta-parameter.
      hidden - specifies sensitive information that should be protected.
      auditable - specifies if the parameter can be auditable or should be masked instead.
      reference -
      components -

    • MetaParameter

      public MetaParameter(String name, boolean multivalued, boolean mandatory, Class<?> javaType, boolean hidden, boolean auditable, String reference, Set<String> allowedReferences, Collection<MetaParameter> components)
      Creates a MetaParameter.
      Parameters:
      name - the name.
      multivalued - the multivalued attribute. true specifies a parameter which can hold multiple values.
      mandatory -
      javaType - the java type for the values that hold the parameter represented by this meta-parameter.
      hidden - specifies sensitive information that should be protected.
      auditable - specifies if the parameter can be auditable or should be masked instead.
      reference -
      components -

  • Method Details

    • getLabel

      public String getLabel()
      Returns:

    • getDisplayName

      public String getDisplayName()
      Returns:

    • setDisplayName

      public void setDisplayName(String displayName)
      Parameters:
      displayName -

    • getHelpText

      public String getHelpText()
      Returns:

    • setHelpText

      public void setHelpText(String helpText)
      Parameters:
      helpText -

    • getName

      public String getName()
      Obtains the name of the parameter represented by this meta-parameter.
      Returns:
      the name of the parameter represented by this meta-parameter.

    • setName

      public void setName(String name)
      Sets the name for the parameter represented by this meta-parameter.
      Parameters:
      name - the name for the parameter represented by this meta-parameter.

    • isMultivalued

      public boolean isMultivalued()
      Obtains whether the parameter represented by this meta-parameter is multivalued or not.
      Returns:
      whether the parameter represented by this meta-parameter is multivalued or not.

    • setMultivalued

      public void setMultivalued(boolean multivalued)
      Sets the multivalued attribute for the parameter represented by this meta-parameter.
      Parameters:
      multivalued - the multivalued attribute. true specifies a parameter which can hold multiple values.

    • isMandatory

      public boolean isMandatory()
      Obtains whether the parameter represented by this meta-parameter is mandatory or not.
      Returns:
      whether the parameter represented by this meta-parameter is mandatory or not.

    • setMandatory

      public void setMandatory(boolean mandatory)
      Sets the mandatory attribute for the parameter represented by this meta-parameter.
      Parameters:
      mandatory - the mandatory attribute. true specifies a parameter that is required.

    • getJavaType

      public Class<?> getJavaType()
      Returns the java type for the values that holds the parameter represented by this meta-parameter.
      Returns:
      the java type for the values that holds the parameter represented by this meta-parameter.

    • setJavaType

      public void setJavaType(Class<?> javaType)
      Sets the java type for the values that holds the parameter represented by this meta-parameter.
      Parameters:
      javaType - the java type for the values that holds the parameters represented by this meta-parameter.

    • isHidden

      public boolean isHidden()
      Obtains whether the parameter represented by this meta-parameter is hidden or not.
      Returns:
      whether the parameter represented by this meta-parameter is hidden or not.

    • setHidden

      public void setHidden(boolean hidden)
      Sets the hidden attribute for the parameter represented by this meta-parameter.
      Parameters:
      hidden - the hidden attribute. true specifies a parameter that holds sensitive information so it should be protected.

    • isAuditable

      public boolean isAuditable()
      Obtains whether the parameter represented by this meta-parameter is sensitive or not. In case that it is sensitive it will be masked when printing it.
      Returns:
      whether the parameter represented by this meta-parameter is sensitive or not.

    • setAuditable

      public void setAuditable(boolean auditable)
      Sets the sensitive attribute for the parameter represented by this meta-parameter.
      Parameters:
      auditable - the auditable attribute. true specifies a parameter that holds sensitive information so it should be protected and will be replaced by asterisks when printing it.

    • getReference

      public String getReference()
      Returns the java type for the values that holds the parameter represented by this meta-parameter.
      Returns:
      the java type for the values that holds the parameter represented by this meta-parameter.

    • setReference

      public void setReference(String reference)
      Sets the type that holds the meta-configuration for the values of the parameter represented by this meta-parameter.
      Parameters:
      reference - the type that holds the meta-configuration for the values of the parameter represented by this meta-parameter.

    • getAllowedReferences

      public Set<String> getAllowedReferences()
      Returns the set of allowed sub-types of the element type that this meta-parameter can reference.
      Returns:
      the set of allowed sub-types of the element type that this meta-parameter can reference.

    • setAllowedReferences

      public void setAllowedReferences(Set<String> allowedReferences)
      Sets the allowed sub-types of the element type that holds the parameter represented by this meta-parameter.
      Parameters:
      allowedReferences - the allowed sub-types this meta-parameter can reference.

    • getComponents

      public Collection<MetaParameter> getComponents()
      Obtains the Collection of meta-parameters that compounds this meta-parameter.
      Returns:
      the Collection of MetaParameter that compounds this meta-parameter.

    • addComponent

      public void addComponent(MetaParameter metaParam)
      Adds a meta-parameter to the compound meta-parameter.
      Parameters:
      metaParam - the MetaParameter to be added.

    • isEnvironmentDependent

      public boolean isEnvironmentDependent()
      Obtains whether the parameter represented by this meta-parameter is environment-dependent or not.
      Returns:
      whether the parameter represented by this meta-parameter is environment-dependent or not.

    • setEnvironmentDependent

      public void setEnvironmentDependent(boolean environmentDependent)
      Sets the environmentDependent attribute for the parameter represented by this meta-parameter.
      Parameters:
      environmentDependent - the environmentDependent attribute. true specifies a parameter that holds sensitive information than can change between different environments (e.g. development, testing, production).

    • getDefaultConfiguration

      public <T> DefaultConfiguration<T> getDefaultConfiguration()

    • setDefaultConfiguration

      public <T> void setDefaultConfiguration(DefaultConfiguration<T> defaultConfiguration)

    • toString

      public String toString()
      Overrides:
      toString in class Object