de.innovationgate.webgate.api.schemadef

Class WGSchemaDefinition

java.lang.Object

de.innovationgate.webgate.api.schemadef.WGSchemaDefinition

public class WGSchemaDefinition
extends java.lang.Object

The definition of a content schema for an OpenWGA content store, to be automatically enforced

Constructor Summary

Constructors

Constructor and Description
WGSchemaDefinition()

Method Summary

Methods

Modifier and Type	Method and Description
void	addDocumentDefinition(WGSchemaDocumentDefinition docDef) Adds a document definition to the schema
java.util.List<WGSchemaDocumentDefinition>	getDocumentDefinitions() Returns the document definitions of the schema
java.util.Map<java.lang.String,WGSchemaDocumentDefinition>	getDocumentDefinitionsCache() Returns a map of document definitions, mapped by their document keys
double	getVersion() Returns the version of the schema definition format, matching the OpenWGA version that introduced it
void	importSchema(WGSchemaDefinition schemaDef)
boolean	isCreateDefaultLanguage() Determines if a language document for the platform default language should be automatically created
static WGSchemaDefinition	read(java.io.InputStream in) Read a serialized schema definition from an input stream
void	setCreateDefaultLanguage(boolean createDefaultLanguage) Sets if a language document for the platform default language should be automatically created
void	setDocumentDefinitions(java.util.List<WGSchemaDocumentDefinition> documentDefinitions) Sets the document definitions of this schema
void	setVersion(double version) Sets the version of the schema format
void	validate() Validates the schema for logical errors
void	write(java.io.OutputStream out) Serializes the schema definition to an output stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

WGSchemaDefinition

public WGSchemaDefinition()

Method Detail

read

public static WGSchemaDefinition read(java.io.InputStream in)
                               throws java.lang.Exception

Read a serialized schema definition from an input stream

Parameters:

in - The data stream

Returns:

Deserialized schema definition

Throws:

java.lang.Exception

write

public void write(java.io.OutputStream out)
           throws java.lang.Exception

Serializes the schema definition to an output stream. The written data can again be deserialized using read(InputStream).

Parameters:

out - The stream to write the schema to.

Throws:

java.lang.Exception

validate

public void validate()
              throws WGSchemaValidationException,
                     WGAPIException

Validates the schema for logical errors

Throws:

WGSchemaValidationException - If an error is found

WGAPIException

isCreateDefaultLanguage

public boolean isCreateDefaultLanguage()

Determines if a language document for the platform default language should be automatically created

setCreateDefaultLanguage

public void setCreateDefaultLanguage(boolean createDefaultLanguage)

Sets if a language document for the platform default language should be automatically created

getDocumentDefinitionsCache

public java.util.Map<java.lang.String,WGSchemaDocumentDefinition> getDocumentDefinitionsCache()

Returns a map of document definitions, mapped by their document keys

addDocumentDefinition

public void addDocumentDefinition(WGSchemaDocumentDefinition docDef)

Adds a document definition to the schema

getDocumentDefinitions

public java.util.List<WGSchemaDocumentDefinition> getDocumentDefinitions()

Returns the document definitions of the schema

setDocumentDefinitions

public void setDocumentDefinitions(java.util.List<WGSchemaDocumentDefinition> documentDefinitions)

Sets the document definitions of this schema

getVersion

public double getVersion()

Returns the version of the schema definition format, matching the OpenWGA version that introduced it

setVersion

public void setVersion(double version)

Sets the version of the schema format

importSchema

public void importSchema(WGSchemaDefinition schemaDef)