org.bremersee.xml

Interface SchemaBuilder

public interface SchemaBuilder

The schema builder wraps the standard SchemaFactory of Java into a builder. It also offers the ability to load schema using Spring's ResourceLoader.

Author:

Christian Bremer

Method Summary

Modifier and Type	Method and Description
static SchemaBuilder	builder() Creates a new schema builder.
default Schema	buildSchema(Collection<? extends Source> sources) Builds schema.
Schema	buildSchema(File file) Builds schema.
default Schema	buildSchema(Source source) Builds schema.
Schema	buildSchema(Source[] sources) Builds schema.
default Schema	buildSchema(String... locations) Retrieves the schema files of the specified locations and builds the schema.
Schema	buildSchema(URL url) Builds schema.
SchemaBuilder	copy() Copy schema builder.
List<Source>	fetchSchemaSources(Collection<String> locations) Retrieves the schema files of the specified locations.
default List<Source>	fetchSchemaSources(String... locations) Retrieves the schema files of the specified locations.
SchemaBuilder	withClassLoader(ClassLoader classLoader) Specifies the class loader to use.
SchemaBuilder	withErrorHandler(ErrorHandler errorHandler) Specifies the error handler to use.
SchemaBuilder	withFactory(String factoryClassName) Specifies the factory to use.
SchemaBuilder	withFeature(String name, Boolean value) Adds a feature to the schema factory.
SchemaBuilder	withProperty(String name, Object value) Adds a property to the schema factory.
SchemaBuilder	withResourceLoader(org.springframework.core.io.ResourceLoader resourceLoader) Specifies the resource loader to use.
SchemaBuilder	withResourceResolver(LSResourceResolver resourceResolver) Specifies the resource resolver to use.
SchemaBuilder	withSchemaLanguage(String schemaLanguage) Specifies the schema language.

Method Detail

copy

SchemaBuilder copy()

Copy schema builder.

Returns:

the schema builder

withSchemaLanguage

SchemaBuilder withSchemaLanguage(String schemaLanguage)

Specifies the schema language.

Default is javax.xml.XMLConstants.W3C_XML_SCHEMA_NS_URI ("http://www.w3.org/2001/XMLSchema").

Parameters:

schemaLanguage - specifies the schema language which the used schema factory will understand

Returns:

the schema builder

See Also:

SchemaFactory.newInstance(String)

withFactory

SchemaBuilder withFactory(String factoryClassName)

Specifies the factory to use.

Parameters:

factoryClassName - the factory class name

Returns:

the schema builder

See Also:

SchemaFactory.newInstance(String, String, ClassLoader)

withClassLoader

SchemaBuilder withClassLoader(ClassLoader classLoader)

Specifies the class loader to use.

Parameters:

classLoader - the class loader

Returns:

the schema builder

See Also:

SchemaFactory.newInstance(String, String, ClassLoader)

withResourceLoader

SchemaBuilder withResourceLoader(org.springframework.core.io.ResourceLoader resourceLoader)

Specifies the resource loader to use. The resource loader is used to retrieve the xsd files that are specified in the schema location (see fetchSchemaSources(String...)).

Default is DefaultResourceLoader.

Parameters:

resourceLoader - the resource loader

Returns:

the schema builder

withResourceResolver

SchemaBuilder withResourceResolver(LSResourceResolver resourceResolver)

Specifies the resource resolver to use.

Parameters:

resourceResolver - the resource resolver

Returns:

the schema builder

See Also:

SchemaFactory.setResourceResolver(LSResourceResolver)

withErrorHandler

SchemaBuilder withErrorHandler(ErrorHandler errorHandler)

Specifies the error handler to use.

Parameters:

errorHandler - the error handler

Returns:

the schema builder

See Also:

SchemaFactory.setErrorHandler(ErrorHandler)

withFeature

SchemaBuilder withFeature(String name,
                          Boolean value)

Adds a feature to the schema factory.

Parameters:

name - the name

value - the value

Returns:

the schema builder

See Also:

SchemaFactory.setFeature(String, boolean)

withProperty

SchemaBuilder withProperty(String name,
                           Object value)

Adds a property to the schema factory.

Parameters:

name - the name

value - the value

Returns:

the schema builder

See Also:

SchemaFactory.setProperty(String, Object)

fetchSchemaSources

default List<Source> fetchSchemaSources(String... locations)

Retrieves the schema files of the specified locations.

The location can have any format that is supported by the ResourceLoader.

Parameters:

locations - the locations

Returns:

the list

See Also:

withResourceLoader(ResourceLoader)

fetchSchemaSources

List<Source> fetchSchemaSources(Collection<String> locations)

Retrieves the schema files of the specified locations.

The location can have any format that is supported by the ResourceLoader.

Parameters:

locations - the locations

Returns:

the schema files as source list

See Also:

withResourceLoader(ResourceLoader)

buildSchema

default Schema buildSchema(String... locations)

Retrieves the schema files of the specified locations and builds the schema.

The location can have any format that is supported by the ResourceLoader.

Parameters:

locations - the locations

Returns:

the schema

buildSchema

Schema buildSchema(URL url)

Builds schema.

Parameters:

url - the url

Returns:

the schema

See Also:

SchemaFactory.newSchema(URL)

buildSchema

Schema buildSchema(File file)

Builds schema.

Parameters:

file - the file

Returns:

the schema

See Also:

SchemaFactory.newSchema(File)

buildSchema

default Schema buildSchema(Source source)

Builds schema.

Parameters:

source - the source

Returns:

the schema

See Also:

SchemaFactory.newSchema(Source)

buildSchema

Schema buildSchema(Source[] sources)

Builds schema.

Parameters:

sources - the sources

Returns:

the schema

See Also:

SchemaFactory.newSchema(Source[])

buildSchema

default Schema buildSchema(Collection<? extends Source> sources)

Builds schema.

Parameters:

sources - the sources

Returns:

the schema

See Also:

SchemaFactory.newSchema(Source[])

builder

static SchemaBuilder builder()

Creates a new schema builder.

Returns:

the schema builder