Package org.ametys.runtime.model.checker

Class ItemCheckerDescriptor

java.lang.Object
org.apache.avalon.framework.logger.AbstractLogEnabled
org.ametys.runtime.model.checker.ItemCheckerDescriptor
All Implemented Interfaces:
Labelable, ModifiableLabelable, LogEnabled
Direct Known Subclasses:
ConfigParameterCheckerDescriptor
public class ItemCheckerDescriptor extends AbstractLogEnabled implements ModifiableLabelable
Descriptor of a parameter checker

  • Field Details

    • _id

      protected String _id
      The parameter checker's id

    • _description

      protected I18nizableText _description
      The parameters checker's description

    • _label

      protected I18nizableText _label
      The parameter checker's label

    • _smallIconPath

      protected String _smallIconPath
      The path of the small icon

    • _mediumIconPath

      protected String _mediumIconPath
      The path of the medium icon

    • _largeIconPath

      protected String _largeIconPath
      The path of the large icon

    • _concreteClass

      protected String _concreteClass
      The concrete class of the parameter checker

    • _uiRefOrder

      protected int _uiRefOrder
      The order of the parameter checker. When several parameter checkers have the same location, the order allows to order graphically the parameter checkers: the parameter checker with the lowest order will be at the top.

    • _uiRefLocation

      protected String _uiRefLocation
      The location of the parameter checker

    • _linkedParamsPaths

      protected Set<String> _linkedParamsPaths
      The configuration of the linked parameters

    • _parameterChecker

      protected ItemChecker _parameterChecker
      The concrete class of the parameter checker implementing the check

  • Constructor Details

  • Method Details

    • toSAX

      public void toSAX(ContentHandler handler) throws SAXException
      SAX the description informations
      Parameters:
      handler - The handler where to sax
      Throws:
      SAXException - if an error occurred

    • toJSON

      public Map<String,Object> toJSON()
      Get the description information to JSON format
      Returns:
      The information as a map

    • getName

      public String getName()
      Description copied from interface: Labelable
      Get the name.
      Specified by:
      getName in interface Labelable
      Returns:
      the name.

    • getId

      @Deprecated public String getId()
      Deprecated.
      use getName() instead
      Retrieves the parameter checker's id
      Returns:
      _id the id of the parameter checker

    • setName

      public void setName(String name)
      Description copied from interface: ModifiableLabelable
      Set the name.
      Specified by:
      setName in interface ModifiableLabelable
      Parameters:
      name - the name.

    • setId

      @Deprecated public void setId(String id)
      Deprecated.
      use setName(String) instead
      Sets the parameter checker's id
      Parameters:
      id - the id of the parameter checker

    • getLabel

      public I18nizableText getLabel()
      Description copied from interface: Labelable
      Retrieves the label.
      Specified by:
      getLabel in interface Labelable
      Returns:
      the label.

    • setLabel

      public void setLabel(I18nizableText label)
      Description copied from interface: ModifiableLabelable
      Set the label.
      Specified by:
      setLabel in interface ModifiableLabelable
      Parameters:
      label - the label.

    • getDescription

      public I18nizableText getDescription()
      Description copied from interface: Labelable
      Retrieves the description.
      Specified by:
      getDescription in interface Labelable
      Returns:
      the description.

    • setDescription

      public void setDescription(I18nizableText description)
      Description copied from interface: ModifiableLabelable
      Set the description.
      Specified by:
      setDescription in interface ModifiableLabelable
      Parameters:
      description - the description.

    • getSmallIconPath

      public String getSmallIconPath()
      Retrieves the parameter checker's icon
      Returns:
      _iconPath the path to the icon representing the parameter checker

    • setSmallIconPath

      public void setSmallIconPath(String path)
      Sets the icon path of the parameter checker
      Parameters:
      path - the path of the small icon

    • getMediumIconPath

      public String getMediumIconPath()
      Retrieves the parameter checker's icon
      Returns:
      _iconPath the path to the icon representing the parameter checker

    • setMediumIconPath

      public void setMediumIconPath(String path)
      Sets the icon path of the parameter checker
      Parameters:
      path - the path of the medium icon

    • getLargeIconPath

      public String getLargeIconPath()
      Retrieves the parameter checker's icon
      Returns:
      _iconPath the path to the icon representing the parameter checker

    • setLargeIconPath

      public void setLargeIconPath(String path)
      Sets the icon path of the parameter checker
      Parameters:
      path - the path of the large icon

    • getConcreteClass

      public String getConcreteClass()
      Retrieves the class of the parameter checker
      Returns:
      _concreteClass the class of the parameter checker.

    • setClass

      public void setClass(String concreteClass)
      Sets the class of the parameter checker
      Parameters:
      concreteClass - the class of the parameter checker

    • getUiRefOrder

      public int getUiRefOrder()
      Gets the ui order of the parameter checker
      Returns:
      _uiRefOrder the ui order

    • setUiRefOrder

      public void setUiRefOrder(int uiRefOrder)
      Sets the ui order
      Parameters:
      uiRefOrder - the ui order

    • getUiRefLocation

      public String getUiRefLocation()
      Get the location of the parameter checker
      Returns:
      _uiRefOrder the ui order

    • setUiRefLocation

      public void setUiRefLocation(String uiRefLocation)
      Set the location of the parameter checker
      Parameters:
      uiRefLocation - the location of the parameter checker

    • getLinkedParamsPaths

      public Set<String> getLinkedParamsPaths()
      Retrieve the path of the parameters used by the parameter checker
      Returns:
      _linkedParamsPaths the paths of the parameters used by the parameter checker

    • setLinkedParamsPaths

      public void setLinkedParamsPaths(Set<String> linkedParamsPaths)
      Sets the parameters' ids used by the parameter checker
      Parameters:
      linkedParamsPaths - the parameters' ids used by the parameter checker

    • getParameterChecker

      public ItemChecker getParameterChecker()
      Retrieves the parameter checker.
      Returns:
      _parameterChecker the parameter checker

    • setParameterChecker

      public void setParameterChecker(ItemChecker parameterChecker)
      Sets the parameter checker
      Parameters:
      parameterChecker - the parameter checker