Class FilterOpsComplexTypes.BBOXType

  • All Implemented Interfaces:
    ComplexType, Type
    Enclosing class:

    public static class FilterOpsComplexTypes.BBOXType
    extends Object
    The element is defined as a convenient and more compact way of encoding the very common bounding box constraint based on the gml:Box geometry. It is equivalent to the spatial operation ??? meaning that the operator should identify all geometries that spatially interact with the box in some manner.

    TODO To change the template for this generated type comment go to Window - Preferences - Java - Code Style - Code Templates

    • Constructor Summary

      Constructor Description
    • Constructor Detail

      • BBOXType

        public BBOXType()
    • Method Detail

      • getInstance

        public static ComplexType getInstance()
      • 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:
      • getValue

        public Object getValue​(Element element,
                               ElementValue[] value,
                               Attributes attrs,
                               Map<String,​Object> hints)
                        throws SAXException
        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.

        See Also:
        Type.getValue(org.geotools.xml.schema.Element, org.geotools.xml.schema.ElementValue[], org.xml.sax.Attributes, java.util.Map)
      • 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 ...)
        See Also:
      • 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.
        See Also:
      • canEncode

        public boolean canEncode​(Element element,
                                 Object value,
                                 Map<String,​Object> hints)
        Subclass must override this method to allow encoding.
        Specified by:
        canEncode in interface Type
        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.
        false, subclass override to allow encoding
        See Also:
        Type#encode(Element, Object, Writer, Map)
      • 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
        See Also:
      • 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.
        Specified by:
        getAttributes in interface ComplexType
        See Also:
      • 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:
      • 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
        See Also:
      • 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
        See Also:
      • 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
        See Also: