Stax2 API 4.2.2 · org.codehaus.stax2.validation.XMLValidationSchemaFactory

Defines an abstract factory for constructing XMLValidationSchema instances. This abstract base class has methods for instantiating the actual implementation (similar to the way javax.xml.stream.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.

Field Summary

Modifier and Type	Field and Description
public static final String	INTERNAL_ID_SCHEMA_DTD
public static final String	INTERNAL_ID_SCHEMA_RELAXNG
public static final String	INTERNAL_ID_SCHEMA_TREX
public static final String	INTERNAL_ID_SCHEMA_W3C
pack-priv static final String	JAXP_PROP_FILENAME Name of resource file that contains JAXP properties.
protected final String	mSchemaType Schema type this factory instance supports.
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.
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.
public static final String	SERVICE_DEFINITION_PATH Path to resource that should contain implementation class definition.
pack-priv static final HashMap<String, String>	sSchemaIds
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).

Access	Constructor and Description
protected	XMLValidationSchemaFactory(String Schema type this factory supports; one of `SCHEMA_ID_xxx` constants. st)

Method Summary

Modifier and Type	Method and Description
private static XMLValidationSchemaFactory	createNewInstance(ClassLoader cloader, String clsName)
public XMLValidationSchema	createSchema(InputStream in)
public XMLValidationSchema	createSchema(InputStream in, String encoding)
public abstract XMLValidationSchema	createSchema(InputStream in, String encoding, String publicId, String systemId)
public XMLValidationSchema	createSchema(Reader r)
public abstract XMLValidationSchema	createSchema(Reader r, String publicId, String systemId)
public abstract XMLValidationSchema	createSchema(URL url)
public abstract XMLValidationSchema	createSchema(File f)
public abstract Object	getProperty(String propName)
public final String	Returns: Name of schema type (one of `SCHEMA_ID_xxx` constants) that this factory supports. getSchemaType()
public abstract boolean	isPropertySupported(String propName)
public static XMLValidationSchemaFactory	newInstance(String schemaType) Creates a new XMLValidationFactory instance, using the default instance configuration mechanism.
public static XMLValidationSchemaFactory	newInstance(String schemaType, ClassLoader classLoader)
public abstract boolean	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. setProperty(String Name of property to set propName, Object Value to set property to value)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

INTERNAL_ID_SCHEMA_DTD	back to summary
public static final String INTERNAL_ID_SCHEMA_DTD

INTERNAL_ID_SCHEMA_RELAXNG	back to summary
public static final String INTERNAL_ID_SCHEMA_RELAXNG

INTERNAL_ID_SCHEMA_TREX	back to summary
public static final String INTERNAL_ID_SCHEMA_TREX

INTERNAL_ID_SCHEMA_W3C	back to summary
public static final String INTERNAL_ID_SCHEMA_W3C

JAXP_PROP_FILENAME	back to summary
pack-priv static final String JAXP_PROP_FILENAME Name of resource file that contains JAXP properties.

mSchemaType	back to summary
protected final String mSchemaType Schema type this factory instance supports.

P_ENABLE_CACHING	back to summary
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).

P_ENABLE_CACHING

back to summary

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).

P_IS_NAMESPACE_AWARE	back to summary
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.

P_IS_NAMESPACE_AWARE

back to summary

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.

SERVICE_DEFINITION_PATH	back to summary
public static final String SERVICE_DEFINITION_PATH Path to resource that should contain implementation class definition.

sSchemaIds	back to summary
pack-priv static final HashMap<String, String> sSchemaIds

SYSTEM_PROPERTY_FOR_IMPL	back to summary
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).

Constructor Detail

XMLValidationSchemaFactory	back to summary
protected XMLValidationSchemaFactory(String st) Parameters st:String Schema type this factory supports; one of `SCHEMA_ID_xxx` constants.

Method Detail

createNewInstance	back to summary
private static XMLValidationSchemaFactory createNewInstance(ClassLoader cloader, String clsName) throws FactoryConfigurationError

createSchema	back to summary
public XMLValidationSchema createSchema(InputStream in) throws XMLStreamException

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

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

createSchema	back to summary
public XMLValidationSchema createSchema(Reader r) throws XMLStreamException

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

createSchema	back to summary
public abstract XMLValidationSchema createSchema(URL url) throws XMLStreamException

createSchema	back to summary
public abstract XMLValidationSchema createSchema(File f) throws XMLStreamException

getProperty	back to summary
public abstract Object getProperty(String propName)

getSchemaType	back to summary
public final String getSchemaType() Returns:String Name of schema type (one of `SCHEMA_ID_xxx` constants) that this factory supports.

isPropertySupported	back to summary
public abstract boolean isPropertySupported(String propName)

newInstance	back to summary
public static XMLValidationSchemaFactory newInstance(String schemaType) throws FactoryConfigurationError Creates a new XMLValidationFactory instance, using the default instance configuration mechanism.

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

setProperty	back to summary
public abstract boolean setProperty(String propName, Object value) Parameters propName:String Name of property to set value:Object Value to set property to Returns:boolean 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.

public abstract Class XMLValidationSchemaFactory

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail