Package org.geotools.ows.wms.xml

Class WMSComplexTypes._ScaleHintType

Object
_ScaleHintType
All Implemented Interfaces:
ComplexType, Type
Enclosing class:
WMSComplexTypes
protected static class WMSComplexTypes._ScaleHintType extends Object

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    _ScaleHintType()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    cache(Element element, Map hints)
    This method is a directive to the parser whether to keep the data around in memory for post processing.
    boolean
    canEncode(Element element, Object value, Map hints)
    Can I write this object out as element specified?
    void
    encode(Element element, Object value, PrintHandler output, Map hints)
    Encode value as element on the provided output.
    Element
    findChildElement(String name)
    Convinience method used to search this type's children for the requested element by localName.
    String
    getAnyAttributeNameSpace()
    This methos represents the potential 'anyAttribute' declaration's namespace attribute which may occur within a complex type definition.
    Attribute[]
    getAttributes()
    The set of attributes required by this complex type declaration.
    int
    getBlock()
    Specifies a mask which denotes which substitution mechanisms may be used for this complex type definition.
    ElementGrouping
    getChild()
    Returns the child element representing the structure of nested child nodes (if any are allowed).
    Element[]
    getChildElements()
     
    int
    getFinal()
    Specifies a mask which denotes which substitution mechanisms prohibited for use by child definitions of this complex type.
    String
    getId()
    Returns the xml schema id of this complexType if one exists, null otherwise.
    static WMSSchema.WMSComplexType
    getInstance()
     
    Class
    getInstanceType()
    This will return the intended Java Class for this element type.
    String
    getName()
    This returns the XML Schema declaration name of this type (both complex and simple types have names ...)
    URI
    getNamespace()
    This is used for validation of an XML document, and represents the targetNamespace of that this type resides in.
    Type
    getParent()
    This is used to represent the heirarchy represented within an xml schema document(s).
    Object
    getValue(Element element, ElementValue[] value, Attributes attrs, Map hints)
    This method is intended to receive the child elements in the form of ElementValues (@see ElementValue).
    boolean
    isAbstract()
    Returns true when the complexType should be considered abstract, as defined by the XML schema of which this complex type definition is a part.
    boolean
    isDerived()
    This method is used to publish whether this complexType is at the root of an inheritance tree, or a leaf within an inheritance tree.
    boolean
    isMixed()
    Returns true if this complexType allows mixed content (Child elements and a String value).
    protected boolean
    sameName(Element element, ElementValue value)
     

    Methods inherited from class Object

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

  • Constructor Details

    • _ScaleHintType

      protected _ScaleHintType()

  • Method Details

    • getInstance

      public static WMSSchema.WMSComplexType getInstance()

    • getAttributes

      public Attribute[] getAttributes()
      Description copied from interface: ComplexType
      The set of attributes required by this complex type declaration. As per the xml schema definition, there is not an implied order to the attributes. For performance reasons an implementor may wich to order the attributes from most common to least commonly used attributes.

    • getChild

      public ElementGrouping getChild()
      Description copied from interface: ComplexType
      Returns the child element representing the structure of nested child nodes (if any are allowed).
      See Also:

    • getChildElements

      public Element[] getChildElements()

    • getValue

      public Object getValue(Element element, ElementValue[] value, Attributes attrs, Map hints) throws SAXException, OperationNotSupportedException
      Description copied from interface: Type
      This method is intended to receive the child elements in the form of ElementValues (@see ElementValue). Recall that this is a pairing containing a reference to the type and the actual value (do not call .getValue on the types). This should return the real value (interpreted value) for this element based on it's children. Remember, this is a XML is a tree structure, so if you don't include some children, they are gone forever (so be careful when ignoring data).

      If the element had #CData (Nested Child Text), this will appear in the first slot, with a null Element.

      A SAXNotSupportedException should be thrown when the child's [inherited, default implementation of getValue(ElementValue[],Attributes)] method should be used.

      Returns:
      Object
      Throws:
      SAXException
      OperationNotSupportedException
      See Also:

    • getName

      public String getName()
      Description copied from interface: Type
      This returns the XML Schema declaration name of this type (both complex and simple types have names ...)

    • getInstanceType

      public Class getInstanceType()
      Description copied from interface: Type
      This will return the intended Java Class for this element type. For generic complex types this will be an object array. SimpleTypes will match as they are parsed, and custom extensions will also return the appropriate class value.

    • canEncode

      public boolean canEncode(Element element, Object value, Map hints)
      Description copied from interface: Type
      Can I write this object out as element specified?
      Parameters:
      element - The element which may be used to represent the Object. This is included to allow for child definitions to include addition information where appropriate.
      value - An Object which may or may not be encodeable by this type. The value may also be null.
      Returns:
      True when the encode method can interpret the given element/value pair into valid xml.
      See Also:
      • Type#encode(Element, Object, Writer, Map)

    • encode

      public void encode(Element element, Object value, PrintHandler output, Map hints) throws IOException, OperationNotSupportedException
      Description copied from interface: Type
      Encode value as element on the provided output.

      This is encoding because the PrintHandler does not have to go back to a stream.

      Parameters:
      element - The original element declaration to which we should encode.
      value - The Object to encode.
      output - This is where the output should be written to.
      hints - For providing additional context information to specific schemas.
      Throws:
      IOException - When there is an error with the Writer.
      OperationNotSupportedException - When this type cannot be encoded ... and wasn't checked first.

    • getParent

      public Type getParent()
      Description copied from interface: ComplexType
      This is used to represent the heirarchy represented within an xml schema document(s). This is particularily useful, as the parent will have the first attempt to create a real (non Object[]) value of the element. For more information see getValue.
      Specified by:
      getParent in interface ComplexType
      See Also:
      • Type#getValue(Element, ElementValue[], Attributes)

    • isAbstract

      public boolean isAbstract()
      Description copied from interface: ComplexType
      Returns true when the complexType should be considered abstract, as defined by the XML schema of which this complex type definition is a part.
      Specified by:
      isAbstract in interface ComplexType

    • getAnyAttributeNameSpace

      public String getAnyAttributeNameSpace()
      Description copied from interface: ComplexType
      This methos represents the potential 'anyAttribute' declaration's namespace attribute which may occur within a complex type definition.
      Specified by:
      getAnyAttributeNameSpace in interface ComplexType

    • getBlock

      public int getBlock()
      Description copied from interface: ComplexType
      Specifies a mask which denotes which substitution mechanisms may be used for this complex type definition.
      Specified by:
      getBlock in interface ComplexType
      See Also:

    • getFinal

      public int getFinal()
      Description copied from interface: ComplexType
      Specifies a mask which denotes which substitution mechanisms prohibited for use by child definitions of this complex type.
      Specified by:
      getFinal in interface ComplexType
      See Also:

    • getId

      public String getId()
      Description copied from interface: ComplexType
      Returns the xml schema id of this complexType if one exists, null otherwise.
      Specified by:
      getId in interface ComplexType

    • isMixed

      public boolean isMixed()
      Description copied from interface: ComplexType
      Returns true if this complexType allows mixed content (Child elements and a String value).
      Specified by:
      isMixed in interface ComplexType

    • isDerived

      public boolean isDerived()
      Description copied from interface: ComplexType
      This method is used to publish whether this complexType is at the root of an inheritance tree, or a leaf within an inheritance tree. This method should return true when the complexType is not a root of an inheritance tree.
      Specified by:
      isDerived in interface ComplexType

    • cache

      public boolean cache(Element element, Map hints)
      Description copied from interface: ComplexType
      This method is a directive to the parser whether to keep the data around in memory for post processing. Generally this should return True, except when streaming.
      Specified by:
      cache in interface ComplexType
      Returns:
      True, except when streaming the element.

    • getNamespace

      public URI getNamespace()
      Description copied from interface: Type
      This is used for validation of an XML document, and represents the targetNamespace of that this type resides in.
      Specified by:
      getNamespace in interface Type

    • findChildElement

      public Element findChildElement(String name)
      Description copied from interface: Type
      Convinience method used to search this type's children for the requested element by localName.
      Specified by:
      findChildElement in interface Type
      Parameters:
      name - the element's localName to search for.

    • sameName

      protected boolean sameName(Element element, ElementValue value)