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

Interface SchemaXml

All Superinterfaces:

com.fishlib.base.log.LogOutputAppendable, Schema, Serializable, TableDefinitionSchema

All Known Implementing Classes:

InvalidSchema

public interface SchemaXml
extends Schema

Add XML related support to Schema.

Nested Class Summary

Nested classes/interfaces inherited from interface com.illumon.iris.db.schema.Schema

Schema.AbstractSchema, Schema.Delegating

Method Summary

Modifier and Type	Method	Description
@NotNull org.jdom2.Element	getElement()
@Nullable org.jdom2.Element	getExtendedStorageElement()	Schema.getExtendedStorage(), as an XML Element.
@NotNull SchemaXml	getImmutable()	Get an immutable copy of this Schema.
@Nullable org.jdom2.Element	getImportSourceElement(@NotNull String type, @Nullable String sourceName)	Schema.getImportSource(String, String), as an XML Element.
@NotNull List<org.jdom2.Element>	getListenerElements()	Schema.getListeners(), with Listeners as XML Elements.
@NotNull List<org.jdom2.Element>	getLoggerElements()	Schema.getLoggers(), with Loggers as XML Elements.

Methods inherited from interface com.illumon.iris.db.schema.Schema

getAttributes, getAttributeValue, getDataIndexSets, getExtendedStorage, getImportSource, getImportSources, getImportSources, getInputTableStateSpec, getListeners, getLogFormats, getLoggers, getMutable, getPartitionKeyFormula, getValidator, hasListeners, hasLoggers

Methods inherited from interface com.illumon.iris.db.schema.TableDefinitionSchema

append, getColumnDescriptions, getDefaultMergeFormat, getMergeCodecName, getNamespace, getNamespaceSet, getStorageType, getTableDefinition, getTableDescription, getTableName, getTableType, getTableTypeV2, getVersion

Method Details

getImmutable

@NotNull
@NotNull SchemaXml getImmutable()

Description copied from interface: Schema

Get an immutable copy of this Schema. May return itself if it is already immutable.

Specified by:

getImmutable in interface Schema

Returns:

An immutable copy of this schema.

getElement

@NotNull
@NotNull org.jdom2.Element getElement()

Returns:

The underlying XML element describing this schema.

getImportSourceElement

@Nullable
@Nullable org.jdom2.Element getImportSourceElement(@NotNull
 @NotNull String type,
 @Nullable
 @Nullable String sourceName)

Schema.getImportSource(String, String), as an XML Element.

Parameters:

type - the import source type

sourceName - the import source name, may be null

Returns:

the identified import source, or null if not found

getLoggerElements

@NotNull
@NotNull List<org.jdom2.Element> getLoggerElements()

Schema.getLoggers(), with Loggers as XML Elements.

Returns:

an immutable list of Loggers

getListenerElements

@NotNull
@NotNull List<org.jdom2.Element> getListenerElements()

Schema.getListeners(), with Listeners as XML Elements.

Returns:

an immutable list of Listeners

getExtendedStorageElement

@Nullable
@Nullable org.jdom2.Element getExtendedStorageElement()

Schema.getExtendedStorage(), as an XML Element.

Returns:

the ExtendedStorage Element if set, or null.