Package org.springframework.extensions.webscripts

Class AbstractBaseDescriptionDocument

java.lang.Object

org.springframework.extensions.webscripts.AbstractBaseDescription

org.springframework.extensions.webscripts.AbstractBaseDescriptionDocument

All Implemented Interfaces:

BaseDescription, BaseDescriptionDocument

Direct Known Subclasses:

DescriptionImpl, PackageDescriptionDocument, SchemaDescriptionDocument

public abstract class AbstractBaseDescriptionDocument
extends AbstractBaseDescription
implements BaseDescriptionDocument

Abstract class for implementation of AbstractBaseDescriptionDocument interface

Author:

drq

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMMON_XML_HEADER
static final String	COMMON_XML_NS
static final String	NEW_LINE
static final String	TAB

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
InputStream	getDescDocument()	Gets the description xml document for this base description document
String	getDescPath()	Gets the path of the description xml document for this base description document
Store	getStore()
String	getStorePath()	Gets the root path of the store of this base description document
void	parseDocument(InputStream doc)	Parses input XML document
void	setDescPath(String descPath)	Sets the desc path
void	setStore(Store store)	Sets the web description store

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

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

Methods inherited from class java.lang.Object

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

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

getDescription, getId, getShortName

Field Details

COMMON_XML_HEADER

public static final String COMMON_XML_HEADER

See Also:

• Constant Field Values

COMMON_XML_NS

public static final String COMMON_XML_NS

See Also:

• Constant Field Values

NEW_LINE

public static final String NEW_LINE

See Also:

• Constant Field Values

TAB

public static final String TAB

See Also:

• Constant Field Values

Constructor Details

AbstractBaseDescriptionDocument

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

Constructor with id, shortName and description

Parameters:

id - String

shortName - String

description - String

AbstractBaseDescriptionDocument

public AbstractBaseDescriptionDocument()

Default constructor

Method Details

setStore

public void setStore(Store store)

Sets the web description store

Parameters:

store - store

setDescPath

public void setDescPath(String descPath)

Sets the desc path

Parameters:

descPath - String

getDescPath

public String getDescPath()

Description copied from interface: BaseDescriptionDocument

Gets the path of the description xml document for this base description document

Specified by:

getDescPath in interface BaseDescriptionDocument

Returns:

document location (path)

getDescDocument

public InputStream getDescDocument()
                            throws IOException

Description copied from interface: BaseDescriptionDocument

Gets the description xml document for this base description document

Specified by:

getDescDocument in interface BaseDescriptionDocument

Returns:

source document

Throws:

IOException

getStorePath

public String getStorePath()

Description copied from interface: BaseDescriptionDocument

Gets the root path of the store of this base description document

Specified by:

getStorePath in interface BaseDescriptionDocument

Returns:

root path of store

getStore

public Store getStore()

Returns:

the store

parseDocument

public void parseDocument(InputStream doc)
                   throws org.dom4j.DocumentException

Parses input XML document

Parameters:

doc - input XML document

Throws:

org.dom4j.DocumentException