Package org.springframework.extensions.webscripts

Class AbstractBaseDescription

    • Constructor Summary

      Constructors 
      Constructor Description
      AbstractBaseDescription()
      Default constructor
      AbstractBaseDescription​(java.lang.String id, java.lang.String shortName, java.lang.String description)
      Constructor with id, shortName and description

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected boolean compareField​(java.lang.String text1, java.lang.String text2)
      Utility function for comparing two strings
      java.lang.String getDescription()
      Gets the description of this base description
      java.lang.String getId()
      Gets the id of this base description
      java.lang.String getShortName()
      Gets the short name of this base description
      void parse​(org.dom4j.Element rootElement)
      Populates fields from given XML element without validation
      void setDescription​(java.lang.String description)
      Sets the service description
      void setId​(java.lang.String id)
      Sets the service id
      void setShortName​(java.lang.String shortName)
      Sets the service short name
      boolean validateRootElement​(org.dom4j.Element rootElement, java.lang.String name)
      Validate XML root element which will be used for parsing

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • AbstractBaseDescription

        public AbstractBaseDescription​(java.lang.String id,
                               java.lang.String shortName,
                               java.lang.String description)
        Constructor with id, shortName and description
        Parameters:
        id - String
        shortName - String
        description - String

      • AbstractBaseDescription

        public AbstractBaseDescription()
        Default constructor

    • Method Detail

      • setId

        public void setId​(java.lang.String id)
        Sets the service id
        Parameters:
        id - String

      • getId

        public java.lang.String getId()
        Description copied from interface: BaseDescription
        Gets the id of this base description
        Specified by:
        getId in interface BaseDescription
        Returns:
        id

      • setShortName

        public void setShortName​(java.lang.String shortName)
        Sets the service short name
        Parameters:
        shortName - String

      • setDescription

        public void setDescription​(java.lang.String description)
        Sets the service description
        Parameters:
        description - String

      • getDescription

        public java.lang.String getDescription()
        Description copied from interface: BaseDescription
        Gets the description of this base description
        Specified by:
        getDescription in interface BaseDescription
        Returns:
        description

      • getShortName

        public java.lang.String getShortName()
        Description copied from interface: BaseDescription
        Gets the short name of this base description
        Specified by:
        getShortName in interface BaseDescription
        Returns:
        short name

      • validateRootElement

        public boolean validateRootElement​(org.dom4j.Element rootElement,
                                   java.lang.String name)
        Validate XML root element which will be used for parsing
        Parameters:
        rootElement - root element
        name - required root element name
        Returns:
        true if the root element is valid and the name matches

      • parse

        public void parse​(org.dom4j.Element rootElement)
        Populates fields from given XML element without validation
        Parameters:
        rootElement - root element for parsing

      • compareField

        protected boolean compareField​(java.lang.String text1,
                               java.lang.String text2)
        Utility function for comparing two strings
        Parameters:
        text1 - String
        text2 - String
        Returns:
        true if text2 is same as text1