FilterSchema (Geotools modules 25.2 API)

Object
- FilterSchema

All Implemented Interfaces:

Factory, Schema
```
public class FilterSchema
extends Object
implements Schema
```
Schema for parsing filter content.

Author:

dzwiers

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FilterSchema.FilterElement

Nested Classes
Modifier and Type	Class and Description
`static class`	`FilterSchema.FilterElement`

Field Summary

Fields
Modifier and Type Field and Description

static String FILTER_CAP_KEY

static URI NAMESPACE
- Fields inherited from interface Schema
  ALL, EXTENSION, NONE, RESTRICTION

Fields
Modifier and Type	Field and Description
`static String`	`FILTER_CAP_KEY`
`static URI`	`NAMESPACE`

Constructor Summary

Constructors
Constructor and Description

FilterSchema()

Constructors
Constructor and Description
`FilterSchema()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AttributeGroup[]`	`getAttributeGroups()` This method is intended to provide a list of public AttributeGroups defined by this Schema.
`Attribute[]`	`getAttributes()` This method is intended to provide a list of public Attributes defined by this Schema.
`int`	`getBlockDefault()` This method returns the default block value associated with this schema as a mask.
`ComplexType[]`	`getComplexTypes()` This method is intended to provide a list of public ComplexTypes defined by this Schema.
`Element[]`	`getElements()` This method is intended to provide a list of public Elements defined by this Schema.
`int`	`getFinalDefault()` This method returns the default final value associated with this schema as a mask.
`Group[]`	`getGroups()` This method is intended to provide a list of public Groups defined by this Schema.
`String`	`getId()` This method is intended to provide the ID of this Schema.
`Map<RenderingHints.Key,?>`	`getImplementationHints()` Returns the implementation hints.
`Schema[]`	`getImports()` This method is intended to provide a list of public Imports defined by this Schema.
`static FilterSchema`	`getInstance()`
`String`	`getPrefix()` Gets the recommended prefix for this schema.
`SimpleType[]`	`getSimpleTypes()` This method is intended to provide a list of public SimpleTypes defined by this Schema.
`URI`	`getTargetNamespace()` This returns the intended use name of the Schema (kinda like an ID, for a better definition see the XML Schema Specification).
`URI`	`getURI()`
`String`	`getVersion()` This returns the Schema version ...
`boolean`	`includesURI(URI uri)` This looks to see if the URI passed in is represented by this Schema.
`boolean`	`isAttributeFormDefault()` Returns true when the Default Attribute Form is qualified, false otherwise.
`boolean`	`isElementFormDefault()` Returns true when the Default Element Form is qualified, false otherwise.

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FILTER_CAP_KEY
```
public static final String FILTER_CAP_KEY
```
    See Also:
    
    Constant Field Values
  - NAMESPACE
```
public static final URI NAMESPACE
```
- Constructor Detail
  - FilterSchema
```
public FilterSchema()
```
- Method Detail
  - getInstance
```
public static FilterSchema getInstance()
```
  - getAttributeGroups
```
public AttributeGroup[] getAttributeGroups()
```
    Description copied from interface: Schema
    
    This method is intended to provide a list of public AttributeGroups defined by this Schema. The definition of 'public AttributeGroups' should be interpreted as the set of AttributeGroups available when creating an instance document, extending the schema, or importing the schema.
    
    Specified by:
    
    getAttributeGroups in interface Schema
    
    Returns:
    
    AttributeGroup[]
    
    See Also:
    
    Schema.getAttributeGroups()
  - getAttributes
```
public Attribute[] getAttributes()
```
    Description copied from interface: Schema
    
    This method is intended to provide a list of public Attributes defined by this Schema. The definition of 'public Attributes' should be interpreted as the set of Attributes available when creating an instance document, extending the schema, or importing the schema.
    
    Specified by:
    
    getAttributes in interface Schema
    
    See Also:
    
    Schema.getAttributes()
  - getBlockDefault
```
public int getBlockDefault()
```
    Description copied from interface: Schema
    
    This method returns the default block value associated with this schema as a mask. The keys for the mask are represented as constants at the head of this file. As defined in the XML Schema specification, element and type blocks should only be extended to include this block if one is not specified.
    
    Specified by:
    
    getBlockDefault in interface Schema
    
    Returns:
    
    Block Mask
    
    See Also:
    
    Schema.getBlockDefault()
  - getComplexTypes
```
public ComplexType[] getComplexTypes()
```
    Description copied from interface: Schema
    
    This method is intended to provide a list of public ComplexTypes defined by this Schema. The definition of 'public ComplexTypes' should be interpreted as the set of ComplexTypes available when creating an instance document, extending the schema, or importing the schema.
    
    Specified by:
    
    getComplexTypes in interface Schema
    
    See Also:
    
    Schema.getComplexTypes()
  - getElements
```
public Element[] getElements()
```
    Description copied from interface: Schema
    
    This method is intended to provide a list of public Elements defined by this Schema. The definition of 'public Elements' should be interpreted as the set of Elements available when creating an instance document, extending the schema, or importing the schema.
    
    Specified by:
    
    getElements in interface Schema
    
    See Also:
    
    Schema.getElements()
  - getFinalDefault
```
public int getFinalDefault()
```
    Description copied from interface: Schema
    
    This method returns the default final value associated with this schema as a mask. The keys for the mask are represented as constants at the head of this file. As defined in the XML Schema specification, element and type final values should only be extended to include this final value if one is not specified.
    
    Specified by:
    
    getFinalDefault in interface Schema
    
    Returns:
    
    Final Mask
    
    See Also:
    
    Schema.getFinalDefault()
  - getGroups
```
public Group[] getGroups()
```
    Description copied from interface: Schema
    
    This method is intended to provide a list of public Groups defined by this Schema. The definition of 'public Groups' should be interpreted as the set of Groups available when creating an instance document, extending the schema, or importing the schema.
    
    Specified by:
    
    getGroups in interface Schema
    
    See Also:
    
    Schema.getGroups()
  - getId
```
public String getId()
```
    Description copied from interface: Schema
    
    This method is intended to provide the ID of this Schema.
    
    Specified by:
    
    getId in interface Schema
    
    See Also:
    
    Schema.getId()
  - getImports
```
public Schema[] getImports()
```
    Description copied from interface: Schema
    
    This method is intended to provide a list of public Imports defined by this Schema. The definition of 'public Imports' should be interpreted as the set of Imports available when creating an instance document, extending the schema, or importing the schema.
    
    Specified by:
    
    getImports in interface Schema
    
    See Also:
    
    Schema.getImports()
  - getURI
```
public URI getURI()
```
    Specified by:
    
    getURI in interface Schema
    
    See Also:
    
    Schema.getURI()
  - getPrefix
```
public String getPrefix()
```
    Description copied from interface: Schema
    
    Gets the recommended prefix for this schema.
    
    Specified by:
    
    getPrefix in interface Schema
    
    See Also:
    
    Schema.getPrefix()
  - getSimpleTypes
```
public SimpleType[] getSimpleTypes()
```
    Description copied from interface: Schema
    
    This method is intended to provide a list of public SimpleTypes defined by this Schema. The definition of 'public SimpleTypes' should be interpreted as the set of SimpleTypes available when creating an instance document, extending the schema, or importing the schema.
    
    Specified by:
    
    getSimpleTypes in interface Schema
    
    See Also:
    
    Schema.getSimpleTypes()
  - getTargetNamespace
```
public URI getTargetNamespace()
```
    Description copied from interface: Schema
    
    This returns the intended use name of the Schema (kinda like an ID, for a better definition see the XML Schema Specification).
    
    Specified by:
    
    getTargetNamespace in interface Schema
    
    See Also:
    
    Schema.getTargetNamespace()
  - getVersion
```
public String getVersion()
```
    Description copied from interface: Schema
    
    This returns the Schema version ...
    
    Specified by:
    
    getVersion in interface Schema
    
    See Also:
    
    Schema.getVersion()
  - includesURI
```
public boolean includesURI(URI uri)
```
    Description copied from interface: Schema
    
    This looks to see if the URI passed in is represented by this Schema. Often this method uses some heuritics on the list of included URIs. This allows one Schema to represent one targetNamespace, but be potentially represented in more than one file.
    Used to determine if the uri should provided should be included in an instance document.
    
    Specified by:
    
    includesURI in interface Schema
    
    See Also:
    
    Schema.includesURI(java.net.URI)
  - isAttributeFormDefault
```
public boolean isAttributeFormDefault()
```
    Description copied from interface: Schema
    
    Returns true when the Default Attribute Form is qualified, false otherwise.
    
    Specified by:
    
    isAttributeFormDefault in interface Schema
    
    See Also:
    
    Schema.isAttributeFormDefault()
  - isElementFormDefault
```
public boolean isElementFormDefault()
```
    Description copied from interface: Schema
    
    Returns true when the Default Element Form is qualified, false otherwise.
    
    Specified by:
    
    isElementFormDefault in interface Schema
    
    See Also:
    
    Schema.isElementFormDefault()
  - getImplementationHints
```
public Map<RenderingHints.Key,?> getImplementationHints()
```
    Returns the implementation hints. The default implementation returns en empty map.
    
    Specified by:
    
    getImplementationHints in interface Factory
    
    Returns:
    
    The map of hints, or an empty map if none.

Class FilterSchema

Nested Class Summary

Field Summary

Fields inherited from interface Schema

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

FILTER_CAP_KEY

NAMESPACE

Constructor Detail

FilterSchema

Method Detail

getInstance

getAttributeGroups

getAttributes

getBlockDefault

getComplexTypes

getElements

getFinalDefault

getGroups

getId

getImports

getURI

getPrefix

getSimpleTypes

getTargetNamespace

getVersion

includesURI

isAttributeFormDefault

isElementFormDefault

getImplementationHints