org.geotools.xml

Class DocumentFactory

Object

DocumentFactory

public class DocumentFactory
extends Object

This is the main entry point into the XSI parsing routines.

Example Use:

     Object x = DocumentFactory.getInstance(new URI("MyInstanceDocumentURI");
 

A selection of the hints available to configure parsing:

• VALIDATION_HINT - Boolean.FALSE to disable validation
• DocumentHandler.DEFAULT_NAMESPACE_HINT_KEY - Schema for parsing and validation
• XMLHandlerHints.FLOW_HANDLER_HINT
• XMLHandlerHints.NAMESPACE_MAPPING - Map<String,URL> namespace mapping
• XMLHandlerHints.ENTITY_RESOLVER - control entry resolution
• DISABLE_EXTERNAL_ENTITIES - Boolean.TRUE to disable entity resolution
• XMLHandlerHints.SAX_PARSER_FACTORY - supply factory used by getParser(Map)

Author:

dzwiers, Refractions Research, Inc. http://www.refractions.net

Field Summary

Fields

Modifier and Type	Field and Description
static String	DISABLE_EXTERNAL_ENTITIES When this hint is contained and set to Boolean.TRUE, external entities will be disabled.
static String	VALIDATION_HINT When this hint is contained and set to Boolean.FALSE, element ordering will not be validated.

Constructor Summary

Constructors

Constructor and Description
DocumentFactory()

Method Summary

Modifier and Type	Method and Description
static Object	getInstance(InputStream is, Map<String,Object> hints, Level level) Parses the instance data provided.
static Object	getInstance(URI desiredDocument, Map<String,Object> hints) calls getInstance(URI,Level) with Level.WARNING
static Object	getInstance(URI desiredDocument, Map hints, Level level) Parses the instance data provided.

Methods inherited from class Object

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

Field Detail

VALIDATION_HINT

public static final String VALIDATION_HINT

When this hint is contained and set to Boolean.FALSE, element ordering will not be validated. This key may also affect data validation within the parse routines. The inherent safety of the resulting objects is weekend by turning this param to false.

See Also:

Constant Field Values

DISABLE_EXTERNAL_ENTITIES

public static final String DISABLE_EXTERNAL_ENTITIES

When this hint is contained and set to Boolean.TRUE, external entities will be disabled. This setting is used to alivate XXE attacks, preventing both VALIDATION_HINT and XMLHandlerHints.ENTITY_RESOLVER from being effective.

See Also:

Constant Field Values

Constructor Detail

DocumentFactory

public DocumentFactory()

Method Detail

getInstance

public static Object getInstance(URI desiredDocument,
                                 Map<String,Object> hints)
                          throws SAXException

calls getInstance(URI,Level) with Level.WARNING

Parameters:

desiredDocument -

hints - May be null.

Returns:

Object

Throws:

SAXException

See Also:

getInstance(URI, Map, Level)

getInstance

public static Object getInstance(URI desiredDocument,
                                 Map hints,
                                 Level level)
                          throws SAXException

Parses the instance data provided. This method assumes that the XML document is fully described using XML Schemas. Failure to be fully described as Schemas will result in errors, as opposed to a vid parse.

Parameters:

desiredDocument -

hints - May be null.

level -

Returns:

Object

Throws:

SAXException

See Also:

DocumentFactory#getInstance(URI, Map, Level, boolean)

getInstance

public static Object getInstance(InputStream is,
                                 Map<String,Object> hints,
                                 Level level)
                          throws SAXException

Parses the instance data provided. This method assumes that the XML document is fully described using XML Schemas. Failure to be fully described as Schemas will result in errors, as opposed to a vid parse.

Parameters:

is -

hints - May be null.

level -

Returns:

Object

Throws:

SAXException

See Also:

DocumentFactory#getInstance(InputStream, Map, Level, boolean)