org.springframework.extensions.webscripts

Class PackageDescriptionDocument

java.lang.Object

org.springframework.extensions.webscripts.AbstractBaseDescription

org.springframework.extensions.webscripts.AbstractBaseDescriptionDocument

org.springframework.extensions.webscripts.PackageDescriptionDocument

All Implemented Interfaces:

BaseDescription, BaseDescriptionDocument

public class PackageDescriptionDocument
extends AbstractBaseDescriptionDocument

Package 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	RESOURCES_ELEMENT_NAME
static String	ROOT_ELEMENT_NAME

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

COMMON_XML_HEADER, COMMON_XML_NS, NEW_LINE, TAB

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addResourceDescription(ResourceDescription resouceDescription)
Path	getPackage()
ArrayList<ResourceDescription>	getResourceDescriptionList()
ResourceDescription[]	getResourceDescriptions()
static PackageDescriptionDocument	newInstance() Return a new instance of PackageDecriptionDocument
void	parse(org.dom4j.Element elem) Populates fields from given XML element without validation
void	setPackage(Path scriptPackage) Sets the Package (path version of getScriptPath)
void	setResourceDescriptionList(ArrayList<ResourceDescription> resourceDescriptionList)
void	setResourceDescriptions(ResourceDescription[] resourceDescriptions)
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

RESOURCES_ELEMENT_NAME

public static final String RESOURCES_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

Constructor Detail

PackageDescriptionDocument

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

Constructor with id, shortName, description and definition

Parameters:

id - String

shortName - String

description - String

PackageDescriptionDocument

public PackageDescriptionDocument()

Default constructor

Method Detail

setPackage

public void setPackage(Path scriptPackage)

Sets the Package (path version of getScriptPath)

Parameters:

scriptPackage - Path

getPackage

public Path getPackage()

getResourceDescriptionList

public ArrayList<ResourceDescription> getResourceDescriptionList()

Returns:

the resourceDescriptionList

setResourceDescriptionList

public void setResourceDescriptionList(ArrayList<ResourceDescription> resourceDescriptionList)

Parameters:

resourceDescriptionList - the resourceDescriptionList to set

getResourceDescriptions

public ResourceDescription[] getResourceDescriptions()

Returns:

the resourceDescriptions

setResourceDescriptions

public void setResourceDescriptions(ResourceDescription[] resourceDescriptions)

Parameters:

resourceDescriptions - the resourceDescriptions to set

addResourceDescription

public void addResourceDescription(ResourceDescription resouceDescription)

Parameters:

resouceDescription - ResourceDescription

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 PackageDescriptionDocument newInstance()

Return a new instance of PackageDecriptionDocument

Returns:

a new instance of PackageDecriptionDocument