org.codehaus.stax2.validation

Class XMLValidationSchemaFactory

java.lang.Object

org.codehaus.stax2.validation.XMLValidationSchemaFactory

public abstract class XMLValidationSchemaFactory
extends Object

Defines an abstract factory for constructing XMLValidationSchema instances. This abstract base class has methods for instantiating the actual implementation (similar to the way XMLInputFactory works, and defines the API to use for configuring these instances, as well as factory methods concrete classes implement for actually creating XMLValidationSchema instances.

Note: this class is part of the second major revision of StAX 2 API (StAX2, v2), and is optional for StAX2 implementations to support.

See Also:

XMLInputFactory, XMLValidationSchema, XMLInputFactory2

Field Summary

Fields

Modifier and Type	Field and Description
static String	INTERNAL_ID_SCHEMA_DTD
static String	INTERNAL_ID_SCHEMA_RELAXNG
static String	INTERNAL_ID_SCHEMA_TREX
static String	INTERNAL_ID_SCHEMA_W3C
protected String	mSchemaType Schema type this factory instance supports.
static String	P_ENABLE_CACHING Property that determines whether schema instances created by this factory instance can be cached by the factory; if false, no caching is allowed to be doe; if true, factory can do caching if it wants to.
static String	P_IS_NAMESPACE_AWARE Property that determines whether schemas constructed are namespace-aware, in cases where schema supports both namespace-aware and non-namespace aware modes.
static String	SERVICE_DEFINITION_PATH Path to resource that should contain implementation class definition.
static String	SYSTEM_PROPERTY_FOR_IMPL Defines the system property that can be set to explicitly specify which implementation to use (in case there are multiple StAX2 implementations; or the one used does not specify other mechanisms for the loader to find the implementation class).

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XMLValidationSchemaFactory(String st)

Method Summary

Methods

Modifier and Type	Method and Description
abstract XMLValidationSchema	createSchema(File f)
XMLValidationSchema	createSchema(InputStream in)
XMLValidationSchema	createSchema(InputStream in, String encoding)
abstract XMLValidationSchema	createSchema(InputStream in, String encoding, String publicId, String systemId)
XMLValidationSchema	createSchema(Reader r)
abstract XMLValidationSchema	createSchema(Reader r, String publicId, String systemId)
abstract XMLValidationSchema	createSchema(URL url)
abstract Object	getProperty(String propName)
String	getSchemaType()
abstract boolean	isPropertySupported(String propName)
static XMLValidationSchemaFactory	newInstance(String schemaType) Creates a new XMLValidationFactory instance, using the default instance configuration mechanism.
static XMLValidationSchemaFactory	newInstance(String schemaType, ClassLoader classLoader)
abstract boolean	setProperty(String propName, Object value)

Methods inherited from class java.lang.Object

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

Field Detail

INTERNAL_ID_SCHEMA_DTD

public static final String INTERNAL_ID_SCHEMA_DTD

See Also:

Constant Field Values

INTERNAL_ID_SCHEMA_RELAXNG

public static final String INTERNAL_ID_SCHEMA_RELAXNG

See Also:

Constant Field Values

INTERNAL_ID_SCHEMA_W3C

public static final String INTERNAL_ID_SCHEMA_W3C

See Also:

Constant Field Values

INTERNAL_ID_SCHEMA_TREX

public static final String INTERNAL_ID_SCHEMA_TREX

See Also:

Constant Field Values

SYSTEM_PROPERTY_FOR_IMPL

public static final String SYSTEM_PROPERTY_FOR_IMPL

Defines the system property that can be set to explicitly specify which implementation to use (in case there are multiple StAX2 implementations; or the one used does not specify other mechanisms for the loader to find the implementation class).

See Also:

Constant Field Values

SERVICE_DEFINITION_PATH

public static final String SERVICE_DEFINITION_PATH

Path to resource that should contain implementation class definition.

See Also:

Constant Field Values

P_IS_NAMESPACE_AWARE

public static final String P_IS_NAMESPACE_AWARE

Property that determines whether schemas constructed are namespace-aware, in cases where schema supports both namespace-aware and non-namespace aware modes. In general this only applies to DTDs, since namespace support for DTDs is both optional, and not well specified.

Default value is TRUE. For schema types for which only one value (usually TRUE) is allowed, this property will be ignored.

See Also:

Constant Field Values

P_ENABLE_CACHING

public static final String P_ENABLE_CACHING

Property that determines whether schema instances created by this factory instance can be cached by the factory; if false, no caching is allowed to be doe; if true, factory can do caching if it wants to. The exact rules used to determine unique id of schema instances is factory dependant; it is expected that the implementations use implementation based on unified system ids (serialized URLs or such).

See Also:

Constant Field Values

mSchemaType

protected final String mSchemaType

Schema type this factory instance supports.

Constructor Detail

XMLValidationSchemaFactory

protected XMLValidationSchemaFactory(String st)

Parameters:

st - Schema type this factory supports; one of SCHEMA_ID_xxx constants.

Method Detail

newInstance

public static XMLValidationSchemaFactory newInstance(String schemaType)
                                              throws FactoryConfigurationError

Creates a new XMLValidationFactory instance, using the default instance configuration mechanism.

Throws:

FactoryConfigurationError

newInstance

public static XMLValidationSchemaFactory newInstance(String schemaType,
                                     ClassLoader classLoader)
                                              throws FactoryConfigurationError

Throws:

FactoryConfigurationError

createSchema

public XMLValidationSchema createSchema(InputStream in)
                                 throws XMLStreamException

Throws:

XMLStreamException

createSchema

public XMLValidationSchema createSchema(InputStream in,
                               String encoding)
                                 throws XMLStreamException

Throws:

XMLStreamException

createSchema

public abstract XMLValidationSchema createSchema(InputStream in,
                               String encoding,
                               String publicId,
                               String systemId)
                                          throws XMLStreamException

Throws:

XMLStreamException

createSchema

public XMLValidationSchema createSchema(Reader r)
                                 throws XMLStreamException

Throws:

XMLStreamException

createSchema

public abstract XMLValidationSchema createSchema(Reader r,
                               String publicId,
                               String systemId)
                                          throws XMLStreamException

Throws:

XMLStreamException

createSchema

public abstract XMLValidationSchema createSchema(URL url)
                                          throws XMLStreamException

Throws:

XMLStreamException

createSchema

public abstract XMLValidationSchema createSchema(File f)
                                          throws XMLStreamException

Throws:

XMLStreamException

isPropertySupported

public abstract boolean isPropertySupported(String propName)

setProperty

public abstract boolean setProperty(String propName,
                  Object value)

Parameters:

propName - Name of property to set

value - Value to set property to

Returns:

True if setting succeeded; false if property was recognized but could not be changed to specified value, or if it was not recognized but the implementation did not throw an exception.

getProperty

public abstract Object getProperty(String propName)

getSchemaType

public final String getSchemaType()

Returns:

Name of schema type (one of SCHEMA_ID_xxx constants) that this factory supports.