XMLHandlerHints (Geotools modules 23-SNAPSHOT API)

Object
- XMLHandlerHints

All Implemented Interfaces:

Map<String,Object>
```
public class XMLHandlerHints
extends Object
implements Map<String,Object>
```
Hint object with known parameters for XML parsing.

Author:

Jesse

Nested Class Summary
- Nested classes/interfaces inherited from interface Map
  Map.Entry<K,V>

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ENTITY_RESOLVER` Supplied `EntityResolver` for Schema and/or DTD validation
`static String`	`FILTER_COMPLIANCE_STRICTNESS` Sets the level of compliance that the filter encoder should use
`static String`	`FLOW_HANDLER_HINT` Declares a FlowHandler for the parser to use
`static String`	`NAMESPACE_MAPPING` Declares the schemas to use for parsing.
`static String`	`SAX_PARSER_FACTORY` Supplied `SaxParserFactory`
`static String`	`STREAM_HINT` Tells the parser to "Stream"
`static Integer`	`VALUE_FILTER_COMPLIANCE_HIGH` The value so the parser will be compliant with the Filter 1.0.0 spec.
`static Integer`	`VALUE_FILTER_COMPLIANCE_LOW` The value so that the parser will encode all Geotools filters with no modifications.
`static Integer`	`VALUE_FILTER_COMPLIANCE_MEDIUM` The value so the parser will be slightly more compliant to the Filter 1.0.0 spec.

Constructor Summary

Constructors
Constructor and Description

XMLHandlerHints()

Constructors
Constructor and Description
`XMLHandlerHints()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()`
`boolean`	`containsKey(Object key)`
`boolean`	`containsValue(Object value)`
`Set<Map.Entry<String,Object>>`	`entrySet()`
`boolean`	`equals(Object o)`
`Object`	`get(Object key)`
`int`	`hashCode()`
`boolean`	`isEmpty()`
`Set<String>`	`keySet()`
`Object`	`put(String key, Object value)`
`void`	`putAll(Map<? extends String,? extends Object> other)`
`Object`	`remove(Object key)`
`int`	`size()`
`static EntityResolver`	`toEntityResolver(Map<String,Object> hints)` Looks up `ENTITY_RESOLVER` instance in provided hints, defaulting to setting provided by `GeoTools.getEntityResolver(org.geotools.util.factory.Hints)` (usually `PreventLocalEntityResolver` unless otherwise configured).
`Collection<Object>`	`values()`

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

Methods inherited from interface Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Field Detail
  - NAMESPACE_MAPPING
```
public static final String NAMESPACE_MAPPING
```
    Declares the schemas to use for parsing. Value must be a java.util.Map of objects where String is the Namespace and URI is the URL to use to load the schema.
    
    See Also:
    
    Constant Field Values
  - FLOW_HANDLER_HINT
```
public static final String FLOW_HANDLER_HINT
```
    Declares a FlowHandler for the parser to use
    
    See Also:
    
    Constant Field Values
  - STREAM_HINT
```
public static final String STREAM_HINT
```
    Tells the parser to "Stream"
    
    See Also:
    
    Constant Field Values
  - FILTER_COMPLIANCE_STRICTNESS
```
public static final String FILTER_COMPLIANCE_STRICTNESS
```
    Sets the level of compliance that the filter encoder should use
    
    See Also:
    
    Constant Field Values
  - ENTITY_RESOLVER
```
public static final String ENTITY_RESOLVER
```
    Supplied EntityResolver for Schema and/or DTD validation
    
    See Also:
    
    Constant Field Values
  - SAX_PARSER_FACTORY
```
public static final String SAX_PARSER_FACTORY
```
    Supplied SaxParserFactory
    
    See Also:
    
    Constant Field Values
  - VALUE_FILTER_COMPLIANCE_LOW
```
public static final Integer VALUE_FILTER_COMPLIANCE_LOW
```
    The value so that the parser will encode all Geotools filters with no modifications.
  - VALUE_FILTER_COMPLIANCE_MEDIUM
```
public static final Integer VALUE_FILTER_COMPLIANCE_MEDIUM
```
    The value so the parser will be slightly more compliant to the Filter 1.0.0 spec. It will encode:
```
  BBoxFilter
        or
  FidFilter
  
```
    as
```
  <Filter><BBo>...</BBox><FidFilter fid="fid"/></Filter>
  
```
    It will encode:
```
  BBoxFilter
        and
  FidFilter
  
```
    as
```
  <Filter><FidFilter fid="fid"/></Filter>
  
```
    IMPORTANT: If this compliance level is used and a non-strict FilterFactory is used to create the filter then the original filter must be ran on the retrieved feature because this hint will sometimes cause more features to be returned than is requested. Consider the following filter:
    not(fidFilter).
    this will return all features and so the filtering must be done on the client.
  - VALUE_FILTER_COMPLIANCE_HIGH
```
public static final Integer VALUE_FILTER_COMPLIANCE_HIGH
```
    The value so the parser will be compliant with the Filter 1.0.0 spec.
    It will throw an exception with filters like: BBoxFilter or FidFilter
    It will encode:
```
  BBoxFilter
        and
  FidFilter
  
```
    as
```
  <Filter><FidFilter fid="fid"/></Filter>
  
```
    IMPORTANT: If this compliance level is used and a non-strict FilterFactory is used to create the filter then the original filter must be ran on the retrieved feature because this hint will sometimes cause more features to be returned than is requested. Consider the following filter:
    not(fidFilter). this will return all features and so the filtering must be done on the client.
- Constructor Detail
  - XMLHandlerHints
```
public XMLHandlerHints()
```
- Method Detail
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Map<String,Object>
  - containsKey
```
public boolean containsKey(Object key)
```
    Specified by:
    
    containsKey in interface Map<String,Object>
  - containsValue
```
public boolean containsValue(Object value)
```
    Specified by:
    
    containsValue in interface Map<String,Object>
  - entrySet
```
public Set<Map.Entry<String,Object>> entrySet()
```
    Specified by:
    
    entrySet in interface Map<String,Object>
  - equals
```
public boolean equals(Object o)
```
    Specified by:
    
    equals in interface Map<String,Object>
    
    Overrides:
    
    equals in class Object
  - get
```
public Object get(Object key)
```
    Specified by:
    
    get in interface Map<String,Object>
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Map<String,Object>
    
    Overrides:
    
    hashCode in class Object
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Map<String,Object>
  - keySet
```
public Set<String> keySet()
```
    Specified by:
    
    keySet in interface Map<String,Object>
  - put
```
public Object put(String key,
                  Object value)
```
    Specified by:
    
    put in interface Map<String,Object>
  - putAll
```
public void putAll(Map<? extends String,? extends Object> other)
```
    Specified by:
    
    putAll in interface Map<String,Object>
  - remove
```
public Object remove(Object key)
```
    Specified by:
    
    remove in interface Map<String,Object>
  - size
```
public int size()
```
    Specified by:
    
    size in interface Map<String,Object>
  - values
```
public Collection<Object> values()
```
    Specified by:
    
    values in interface Map<String,Object>
  - toEntityResolver
```
public static EntityResolver toEntityResolver(Map<String,Object> hints)
```
    Looks up ENTITY_RESOLVER instance in provided hints, defaulting to setting provided by GeoTools.getEntityResolver(org.geotools.util.factory.Hints) (usually PreventLocalEntityResolver unless otherwise configured).
    
    Parameters:
    
    hints -
    
    Returns:
    
    EntityResolver provided by hints, or non-null default provided by Hints.ENTITY_RESOLVER.

Class XMLHandlerHints

Nested Class Summary

Nested classes/interfaces inherited from interface Map

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Methods inherited from interface Map

Field Detail

NAMESPACE_MAPPING

FLOW_HANDLER_HINT

STREAM_HINT

FILTER_COMPLIANCE_STRICTNESS

ENTITY_RESOLVER

SAX_PARSER_FACTORY

VALUE_FILTER_COMPLIANCE_LOW

VALUE_FILTER_COMPLIANCE_MEDIUM

VALUE_FILTER_COMPLIANCE_HIGH

Constructor Detail

XMLHandlerHints

Method Detail

clear

containsKey

containsValue

entrySet

equals

get

hashCode

isEmpty

keySet

put

putAll

remove

size

values

toEntityResolver