org.springframework.extensions.webscripts

Class SchemaDescriptionDocument

java.lang.Object

org.springframework.extensions.webscripts.AbstractBaseDescription

org.springframework.extensions.webscripts.AbstractBaseDescriptionDocument

org.springframework.extensions.webscripts.SchemaDescriptionDocument

All Implemented Interfaces:

BaseDescription, BaseDescriptionDocument

public class SchemaDescriptionDocument
extends AbstractBaseDescriptionDocument

Schema description document

Author:

drq

Field Summary

Fields

Modifier and Type	Field and Description
static String	DESC_NAME_PATTERN
static String	DESC_NAME_POSTFIX
static String	ROOT_ELEMENT_NAME
ArrayList<TypeDescription>	typeDescriptionList

Fields inherited from class org.springframework.extensions.webscripts.AbstractBaseDescriptionDocument

COMMON_XML_HEADER, COMMON_XML_NS, NEW_LINE, TAB

Constructor Summary

Constructors

Constructor and Description
SchemaDescriptionDocument() Default constructor
SchemaDescriptionDocument(String id, String shortName, String description) Constructor with id, shortName and desription

Method Summary

Modifier and Type	Method and Description
void	addTypeDescription(TypeDescription typeDescription)
ArrayList<TypeDescription>	getTypeDescriptionList()
TypeDescription[]	getTypeDescriptions()
static SchemaDescriptionDocument	newInstance() Return a new instance of SchemaDescriptDocument
void	parse(org.dom4j.Element elem) Populates fields from given XML element without validation
void	setTypeDescriptionList(ArrayList<TypeDescription> typeDescriptionList)
void	setTypeDescriptions(TypeDescription[] typeDescriptions)
String	toString()

Methods inherited from class org.springframework.extensions.webscripts.AbstractBaseDescriptionDocument

getDescDocument, getDescPath, getStore, getStorePath, parseDocument, setDescPath, setStore

Methods inherited from class org.springframework.extensions.webscripts.AbstractBaseDescription

compareField, getDescription, getId, getShortName, setDescription, setId, setShortName, validateRootElement

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.extensions.webscripts.BaseDescription

getDescription, getId, getShortName

Field Detail

ROOT_ELEMENT_NAME

public static final String ROOT_ELEMENT_NAME

See Also:

Constant Field Values

DESC_NAME_POSTFIX

public static final String DESC_NAME_POSTFIX

See Also:

Constant Field Values

DESC_NAME_PATTERN

public static final String DESC_NAME_PATTERN

See Also:

Constant Field Values

typeDescriptionList

public ArrayList<TypeDescription> typeDescriptionList

Constructor Detail

SchemaDescriptionDocument

public SchemaDescriptionDocument(String id,
                                 String shortName,
                                 String description)

Constructor with id, shortName and desription

Parameters:

id - String

shortName - String

description - String

SchemaDescriptionDocument

public SchemaDescriptionDocument()

Default constructor

Method Detail

getTypeDescriptionList

public ArrayList<TypeDescription> getTypeDescriptionList()

Returns:

the typeDescriptionList

setTypeDescriptionList

public void setTypeDescriptionList(ArrayList<TypeDescription> typeDescriptionList)

Parameters:

typeDescriptionList - the typeDescriptionList to set

getTypeDescriptions

public TypeDescription[] getTypeDescriptions()

Returns:

the schemaDescriptions

setTypeDescriptions

public void setTypeDescriptions(TypeDescription[] typeDescriptions)

Parameters:

typeDescriptions - TypeDescription[]

addTypeDescription

public void addTypeDescription(TypeDescription typeDescription)

Parameters:

typeDescription - TypeDescription

parse

public void parse(org.dom4j.Element elem)

Description copied from class: AbstractBaseDescription

Populates fields from given XML element without validation

Overrides:

parse in class AbstractBaseDescription

Parameters:

elem - root element for parsing

toString

public String toString()

Overrides:

toString in class Object

newInstance

public static SchemaDescriptionDocument newInstance()

Return a new instance of SchemaDescriptDocument

Returns:

SchemaDescriptionDocument