Package org.exolab.castor.xml.schema

Class Facet

    • Constructor Detail

      • Facet

        public Facet​(java.lang.String name,
             java.lang.String value)
        Creates a new Facet with the given name.
        Parameters:
        name - the name of the Facet
        value - the value of the Facet

    • Method Detail

      • getName

        public java.lang.String getName()
        Returns the name of this Facet.
        Returns:
        the name of this Facet

      • getValue

        public java.lang.String getValue()
        Returns the character (String) representation of this facet.
        Returns:
        the value of this facet

      • isMultivalued

        public boolean isMultivalued()
        Returns true if this Facet can occur more than once, such as the "enumeration" facet.
        Returns:
        true if this Facet can occur more than once.

      • toInt

        public int toInt()
          throws java.lang.NumberFormatException
        Returns an int representation of the value of this facet.
        Returns:
        an int representation of the value of this facet
        Throws:
        java.lang.NumberFormatException - if the value fails to parse as a int.

      • toLong

        public long toLong()
            throws java.lang.NumberFormatException
        Returns a long representation of the value of this facet.
        Returns:
        a long representation of the value of this facet
        Throws:
        java.lang.NumberFormatException - if the value fails to parse as a long.

      • toShort

        public short toShort()
              throws java.lang.NumberFormatException
        Returns an short representation of the value of this facet.
        Returns:
        an short representation of the value of this facet
        Throws:
        java.lang.NumberFormatException - if the value fails to parse as a short.

      • toFloat

        public float toFloat()
              throws java.lang.NumberFormatException
        Returns a double representation of the value of this facet.
        Returns:
        a double representation of the value of this facet
        Throws:
        java.lang.NumberFormatException - if the value fails to parse as a float.

      • toDouble

        public double toDouble()
                throws java.lang.NumberFormatException
        Returns a double representation of the value of this facet.
        Returns:
        a double representation of the value of this facet
        Throws:
        java.lang.NumberFormatException - if the value fails to parse as a double.

      • toByte

        public byte toByte()
            throws java.lang.NumberFormatException
        Returns a byte representation of the value of this facet.
        Returns:
        a byte representation of the value of this facet
        Throws:
        java.lang.NumberFormatException - if the value fails to parse as a byte.

      • toBigDecimal

        public java.math.BigDecimal toBigDecimal()
                                  throws java.lang.NumberFormatException
        Returns a BigDecimal representation of the value of this facet.
        Returns:
        a BigDecimal representation of the value of this facet
        Throws:
        java.lang.NumberFormatException - if the value cannot be parsed as number

      • getStructureType

        public short getStructureType()
        Returns the type of this Schema Structure.
        Specified by:
        getStructureType in class Structure
        Returns:
        the type of this Schema Structure

      • overridesBase

        public boolean overridesBase​(Facet baseFacet)
        Checks whether the current facet overrides a facet of the base data type. This does generally happen when a data type is derived by restriction and it therefore has facet(s), which are more restrictive than the ones of the base data type.

        This method is used for merging facets of the base and derived types, in order to create an effective set of facets for the derived type.

        It's important to note that this method does not perform any validity checks. Validation must be generally performed before trying to merge facets of the base and derived types.

        Parameters:
        baseFacet - a facet of the base data type
        Returns:
        true, if the current facet overrides baseFacet; false, otherwise.
        See Also:
        checkConstraints(Enumeration,Enumeration), SimpleType.getEffectiveFacets()

      • checkConstraints

        public void checkConstraints​(java.util.Enumeration localFacets,
                             java.util.Enumeration baseFacets)
                      throws SchemaException
        Checks the constraints on the current facet against the other local facets of the same derived data type and facets of the base data type. Validation is performed according to the rules defined in "XML Schema Part 2: Datatypes Second Edition" document.
        Parameters:
        localFacets - local facets of the data type
        baseFacets - merged facets of the base data type
        Throws:
        SchemaException - when the current facet does not satisfy schema component validation constraints

      • setOwningType

        public void setOwningType​(SimpleType owningType)
        Sets the owning SimpleType instance.
        Parameters:
        owningType - The owning SimpleType instance.