Package ro.sync.contentcompletion.xml

Interface NodeDescription

  • All Known Subinterfaces:
    CIElement
    All Known Implementing Classes:
    CIAttribute, CIElementAdapter
    @API(type=NOT_EXTENDABLE,
     src=PRIVATE)
public interface NodeDescription
    Node description is in fact a collection of properties for a node. The node can be either an attribute or an element.

    • Method Detail

      • getName

        java.lang.String getName()
        Get the node(attribute or element) name.
        Returns:
        The node(attribute or element) name.

      • getPossibleValues

        java.util.List<java.lang.String> getPossibleValues()
        Get the possible values as a list of String values.
        Returns:
        The list of possible values.

      • getModelDescription

        java.lang.String getModelDescription()
        Get the model description.
        Returns:
        The model description.

      • getFacetLengthValue

        java.lang.String getFacetLengthValue()
        Get the value of the LENGTH facet, can be null if it is not defined.
        Returns:
        The value of the LENGTH facet.

      • getFacetMinLengthValue

        java.lang.String getFacetMinLengthValue()
        Get the value of the MIN LENGTH facet, can be null if it is not defined.
        Returns:
        The value of the MIN LENGTH facet.

      • getFacetMaxLengthValue

        java.lang.String getFacetMaxLengthValue()
        Get the value of the MAX LENGTH facet, can be null if it is not defined.
        Returns:
        The value of the MAX LENGTH facet.

      • getFacetWhitespaceValue

        java.lang.String getFacetWhitespaceValue()
        Get the value of the WHITESPACE facet, can be null if it is not defined.
        Returns:
        The value of the WHITESPACE facet.

      • getFacetMinInclusiveValue

        java.lang.String getFacetMinInclusiveValue()
        Get the value of the MIN_INCLUSIVE facet, can be null if it is not defined.
        Returns:
        The value of the MIN_INCLUSIVE facet.

      • getFacetMinExclusiveValue

        java.lang.String getFacetMinExclusiveValue()
        Get the value of the MIN_EXCLUSIVE facet, can be null if it is not defined.
        Returns:
        The value of the MIN_EXCLUSIVE facet.

      • getFacetMaxInclusiveValue

        java.lang.String getFacetMaxInclusiveValue()
        Get the value of the MAX_INCLUSIVE facet, can be null if it is not defined.
        Returns:
        The value of the MAX_INCLUSIVE facet.

      • getFacetMaxExclusiveValue

        java.lang.String getFacetMaxExclusiveValue()
        Get the value of the MAX_EXCLUSIVE facet, can be null if it is not defined.
        Returns:
        The value of the MAX_EXCLUSIVE facet.

      • getFacetTotalDigitsValue

        java.lang.String getFacetTotalDigitsValue()
        Get the value of the TOTAL_DIGITS facet, can be null if it is not defined.
        Returns:
        The value of the TOTAL_DIGITS facet.

      • getFacetFractionDigitsValue

        java.lang.String getFacetFractionDigitsValue()
        Get the value of the FRACTION_DIGITS facet, can be null if it is not defined.
        Returns:
        The value of the FRACTION_DIGITS facet.

      • setFacetFractionDigitsValue

        void setFacetFractionDigitsValue​(java.lang.String fractionDigitsFacetValue)
        Set the value of the FRACTION_DIGITS facet.
        Parameters:
        fractionDigitsFacetValue - The value of the FRACTION_DIGITS facet to set.

      • setFacetMaxExclusiveValue

        void setFacetMaxExclusiveValue​(java.lang.String maxExclusiveFacetValue)
        Set the value of the MAX_EXCLUSIVE facet.
        Parameters:
        maxExclusiveFacetValue - The value of the MAX_EXCLUSIVE facet to set.

      • setFacetMaxInclusiveValue

        void setFacetMaxInclusiveValue​(java.lang.String maxInclusiveFacetValue)
        Set the value of the MAX_INCLUSIVE facet.
        Parameters:
        maxInclusiveFacetValue - The value of the MAX_INCLUSIVE facet to set.

      • setFacetMaxLengthValue

        void setFacetMaxLengthValue​(java.lang.String maxLengthFacetValue)
        Set the value of the MAX_LENGTH facet.
        Parameters:
        maxLengthFacetValue - The value of the MAX_LENGTH facet to set.

      • setFacetMinInclusiveValue

        void setFacetMinInclusiveValue​(java.lang.String minInclusiveFacetValue)
        Set the value of the MIN_INCLUSIVE facet.
        Parameters:
        minInclusiveFacetValue - The value of the MIN_INCLUSIVE facet to set.

      • setPossiblesValues

        void setPossiblesValues​(java.util.List<java.lang.String> possiblesValues)
        Set the list of possible values for the node.
        Parameters:
        possiblesValues - The list with possible (String) values.

      • setFacetTotalDigitsValue

        void setFacetTotalDigitsValue​(java.lang.String totalDigitsFacetValue)
        Set the value of the TOTAL_DIGITS facet.
        Parameters:
        totalDigitsFacetValue - The value of the TOTAL_DIGITS facet to set.

      • setFacetWhitespaceValue

        void setFacetWhitespaceValue​(java.lang.String whitespaceFacetValue)
        Set the value of the WHITESPACE facet.
        Parameters:
        whitespaceFacetValue - The value of the WHITESPACE facet to set.

      • setModelDescription

        void setModelDescription​(java.lang.String modelDescription)
        Set the model description for the node.
        Parameters:
        modelDescription - The modelDescription to set.

      • setFacetLengthValue

        void setFacetLengthValue​(java.lang.String lengthFacetValue)
        Set the value of the LENGTH facet.
        Parameters:
        lengthFacetValue - The value of the LENGTH facet to set.

      • setFacetMinLengthValue

        void setFacetMinLengthValue​(java.lang.String minLengthFacetValue)
        Set the value of the MIN_LENGTH facet.
        Parameters:
        minLengthFacetValue - The value of the MIN_LENGTH facet to set.

      • setFacetMinExclusiveValue

        void setFacetMinExclusiveValue​(java.lang.String minExclusiveFacetValue)
        Set the value of the MIN_EXCLUSIVE facet.
        Parameters:
        minExclusiveFacetValue - The value of the MIN_EXCLUSIVE facet to set.

      • getFacetPattern

        java.lang.String getFacetPattern()
        Get the value of the PATTERN facets as String, can be null if is not defined.
        Returns:
        The PATTERN facets as a String.

      • setFacetPattern

        void setFacetPattern​(java.lang.String patternFacets)
        Set the value of the PATTERN facets.
        Parameters:
        patternFacets - The value of the PATTERN facets to set.

      • getAnnotation

        java.lang.String getAnnotation()
        Returns:
        The node annotation, can be null.

      • setAssertions

        void setAssertions​(java.lang.String assertionsDescription)
        Sets the string representation for the node type assertions.
        Parameters:
        assertionsDescription - The string representing all assertions.

      • getAssertions

        java.lang.String getAssertions()
        Returns the string representation for all assertions. The assertions are collected from node type, by example for simple types they are collected using assertion facets. The representation is (assertion1) && (assertion2) && etc.
        Returns:
        The string containing all assertions. Is null if node type does not have any assertion.

      • setOpenContentMode

        void setOpenContentMode​(java.lang.String mode)
        Sets the mode of the open content. Can be one of 'interleave', 'suffix' or 'none'.
        Parameters:
        mode - The mode of the open content.

      • getOpenContentMode

        java.lang.String getOpenContentMode()
        Returns the mode of the open content. Null if element type does not contains an open content.
        Returns:
        The mode of the open content.

      • setOpenContentWildcardDescription

        void setOpenContentWildcardDescription​(java.lang.String wildcardDescription)
        Sets the description for the open content wildcard.
        Parameters:
        wildcardDescription - The wildcard description.

      • getOpenContentWildcardDescription

        java.lang.String getOpenContentWildcardDescription()
        Returns the description for the open content wildcard.
        Returns:
        The description for the open content wildcard. Null if wildcard is missing.