Package com.illumon.iris.db.schema.xml

Class SchemaXmlFactory

java.lang.Object

com.illumon.iris.db.schema.xml.SchemaXmlFactory

public class SchemaXmlFactory
extends Object

The public entry point into this package. Little else is directly visible outside this package.

Constructor Summary

Constructors

Constructor	Description
SchemaXmlFactory()

Method Summary

Modifier and Type	Method	Description
static SchemaXml	getImmutableXml(SchemaXml schema, boolean alreadyDetached)	Factory method that allows the implementation class to stay private.
static MutableSchema	getMutableSchema(TableDefinition definition, NamespaceSet namespaceSet)	Create a MutableSchema implementation from the given table definition, in the specified namespace set.
static MutableSchema	getMutableSchema(TableDefinition definition, NamespaceSet namespaceSet, boolean useNanosecondTimePrecision)	Create a MutableSchema implementation from the given table definition, in the specified namespace set.
static MutableSchema	getMutableSchema(org.jdom2.Element element)	Create a MutableSchema implementation from the given XML Element.
static com.illumon.iris.db.schema.xml.CopyTableSchemaXml	getXmlCopySchema(CopyTableSchema schema)	Create a SchemaXml implementation from the given XML Element.
static com.illumon.iris.db.schema.xml.CopyTableSchemaXml	getXmlCopySchema(org.jdom2.Element element, SchemaXml sourceSchema)	Create a SchemaXml implementation from the given XML Element.
static SchemaXml	getXmlSchema(TableDefinition definition, NamespaceSet namespaceSet)	Create a SchemaXml implementation from the given table definition, in the specified namespace set.
static SchemaXml	getXmlSchema(String xmlString)	Create a SchemaXml implementation from the given XML String.
static SchemaXml	getXmlSchema(org.jdom2.Element element)	Create a SchemaXml implementation from the given XML Element, using a NO_VERSION SchemaVersion.
static SchemaXml	getXmlSchema(org.jdom2.Element element, SchemaVersion version)	Create a SchemaXml implementation from the given XML Element.

Methods inherited from class java.lang.Object

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

Constructor Details

SchemaXmlFactory

public SchemaXmlFactory()

Method Details

getMutableSchema

public static MutableSchema getMutableSchema(@NotNull
 org.jdom2.Element element)
                                      throws SchemaValidationException

Create a MutableSchema implementation from the given XML Element.

Parameters:

element - the source element

Returns:

a new object implementing MutableSchema

Throws:

SchemaValidationException - if any errors parsing the element

getXmlSchema

public static SchemaXml getXmlSchema(@NotNull
 org.jdom2.Element element,
 @NotNull
 SchemaVersion version)
                              throws SchemaValidationException

Create a SchemaXml implementation from the given XML Element.

Parameters:

element - the source element

version - version info for this schema

Returns:

a new object implementing SchemaXml

Throws:

SchemaValidationException - if any errors parsing the element

getXmlSchema

public static SchemaXml getXmlSchema(@NotNull
 org.jdom2.Element element)
                              throws SchemaValidationException

Create a SchemaXml implementation from the given XML Element, using a NO_VERSION SchemaVersion.

Parameters:

element - the source element

Returns:

a new object implementing SchemaXml

Throws:

SchemaValidationException - if any errors parsing the element

getXmlSchema

public static SchemaXml getXmlSchema(@NotNull
 String xmlString)
                              throws SchemaValidationException

Create a SchemaXml implementation from the given XML String.

Parameters:

xmlString - the XML schema as a String

Returns:

a new object implementing SchemaXml

Throws:

SchemaValidationException - if any errors parsing the element

getXmlCopySchema

public static com.illumon.iris.db.schema.xml.CopyTableSchemaXml getXmlCopySchema(@NotNull
 CopyTableSchema schema)
                                                                          throws SchemaValidationException

Create a SchemaXml implementation from the given XML Element.

Parameters:

schema - the CopyTable schema to convert

Returns:

a new object implementing SchemaXml

Throws:

SchemaValidationException - if any errors parsing the element

getXmlCopySchema

public static com.illumon.iris.db.schema.xml.CopyTableSchemaXml getXmlCopySchema(@NotNull
 org.jdom2.Element element,
 @NotNull
 SchemaXml sourceSchema)
                                                                          throws SchemaValidationException

Create a SchemaXml implementation from the given XML Element.

Parameters:

element - the source element

Returns:

a new object implementing SchemaXml

Throws:

SchemaValidationException - if any errors parsing the element

getXmlSchema

public static SchemaXml getXmlSchema(@NotNull
 TableDefinition definition,
 @NotNull
 NamespaceSet namespaceSet)
                              throws SchemaValidationException

Create a SchemaXml implementation from the given table definition, in the specified namespace set.

Parameters:

definition - the source table definition

namespaceSet - the namespace set for the new schema

Returns:

a new object implementing SchemaXml

Throws:

SchemaValidationException - if any errors parsing the element

getMutableSchema

public static MutableSchema getMutableSchema(@NotNull
 TableDefinition definition,
 @NotNull
 NamespaceSet namespaceSet)
                                      throws SchemaValidationException

Create a MutableSchema implementation from the given table definition, in the specified namespace set.

Parameters:

definition - the source table definition

namespaceSet - the namespace set for the new schema

Returns:

a new object implementing MutableSchema

Throws:

SchemaValidationException - if any errors parsing the element

getMutableSchema

public static MutableSchema getMutableSchema(@NotNull
 TableDefinition definition,
 @NotNull
 NamespaceSet namespaceSet,
 boolean useNanosecondTimePrecision)
                                      throws SchemaValidationException

Create a MutableSchema implementation from the given table definition, in the specified namespace set.

Parameters:

definition - the source table definition

namespaceSet - the namespace set for the new schema

useNanosecondTimePrecision - the namespace set for the new schema

Returns:

a new object implementing MutableSchema

Throws:

SchemaValidationException - if any errors parsing the element

getImmutableXml

public static SchemaXml getImmutableXml(SchemaXml schema,
 boolean alreadyDetached)

Factory method that allows the implementation class to stay private.

Parameters:

schema - source schema to make immutable

alreadyDetached - true indicates that the source schema is safe to use as-is

Returns:

an immutable schema, per Schema.getImmutable() rules.