org.apache.oodt.cas.filemgr.validation

Class XMLValidationLayer

java.lang.Object

org.apache.oodt.cas.filemgr.validation.XMLValidationLayer

All Implemented Interfaces:

ValidationLayer

public class XMLValidationLayer
extends Object
implements ValidationLayer

Version:

$Revision$

An XML ValidationLayer based on two xml files, elements.xml, and product-type-element-map.xml.

Author:

mattmann, bfoster

Constructor Summary

Constructors

Constructor and Description
XMLValidationLayer(List<String> uris)

Method Summary

Methods

Modifier and Type	Method and Description
void	addElement(Element element) Adds the Element to the ValidationLayer.
void	addElementToProductType(ProductType type, Element element) Adds the specified element to the ProductType specified by its productTypeId.
void	addParentForProductType(ProductType type, String parentId) Sets a parentId for an existing ProductType
Element	getElementById(String elementId) Gets an element by its String identifier.
Element	getElementByName(String elementName) Gets an element by its String name.
List<Element>	getElements()
List<Element>	getElements(ProductType type) Returns a List of Elements corresponding to the given ProductType.
List<Element>	getElements(ProductType type, boolean direct) Returns the declared elements for a ProductType
HashMap<String,String>	getSubToSuperMap() Gets the parent-child relationship between product types
void	modifyElement(Element element) Modifies an existing Element in the ValidationLayer.
void	removeElement(Element element) Removes a metadata Element from the ValidationLayer.
void	removeElementFromProductType(ProductType type, Element element) Removes a metadata Element from the specified productTypeId.
void	removeParentForProductType(ProductType type) Removes the parent for a ProductType

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLValidationLayer

public XMLValidationLayer(List<String> uris)

Method Detail

addElement

public void addElement(Element element)
                throws ValidationLayerException

Description copied from interface: ValidationLayer

Adds the Element to the ValidationLayer.

Specified by:

addElement in interface ValidationLayer

Parameters:

element - The element to add.

Throws:

ValidationLayerException - If any error occurs during the add.

modifyElement

public void modifyElement(Element element)
                   throws ValidationLayerException

Description copied from interface: ValidationLayer

Modifies an existing Element in the ValidationLayer.

Specified by:

modifyElement in interface ValidationLayer

Parameters:

element - The new Element data to update.

Throws:

ValidationLayerException - If any error occurs.

removeElement

public void removeElement(Element element)
                   throws ValidationLayerException

Description copied from interface: ValidationLayer

Removes a metadata Element from the ValidationLayer.

Specified by:

removeElement in interface ValidationLayer

Parameters:

element - The element to remove.

Throws:

ValidationLayerException - If any error occurs.

addElementToProductType

public void addElementToProductType(ProductType type,
                           Element element)
                             throws ValidationLayerException

Description copied from interface: ValidationLayer

Adds the specified element to the ProductType specified by its productTypeId.

Specified by:

addElementToProductType in interface ValidationLayer

Parameters:

type - The ProductType to associate the metadata Element with.

element - The Element to associate with the ProductType.

Throws:

ValidationLayerException - If any error occurs.

removeElementFromProductType

public void removeElementFromProductType(ProductType type,
                                Element element)
                                  throws ValidationLayerException

Description copied from interface: ValidationLayer

Removes a metadata Element from the specified productTypeId.

Specified by:

removeElementFromProductType in interface ValidationLayer

Parameters:

type - The ProductType to remove the association of the specified element with.

element - The element whose association will be removed from the specified ProductType.

Throws:

ValidationLayerException - If any error occurs.

getElements

public List<Element> getElements(ProductType type)
                          throws ValidationLayerException

Description copied from interface: ValidationLayer

Returns a List of Elements corresponding to the given ProductType.

Specified by:

getElements in interface ValidationLayer

Parameters:

type - The product type to retrieve the metadata Elements for.

Returns:

A List of Elements corresponding to the given ProductType.

Throws:

ValidationLayerException - If any error occurs.

getElements

public List<Element> getElements()
                          throws ValidationLayerException

Specified by:

getElements in interface ValidationLayer

Returns:

A List of all the metadata Elements in the ValidationLayer.

Throws:

ValidationLayerException - If any error occurs.

getElementById

public Element getElementById(String elementId)
                       throws ValidationLayerException

Description copied from interface: ValidationLayer

Gets an element by its String identifier.

Specified by:

getElementById in interface ValidationLayer

Parameters:

elementId - The String identifier of the Element to get.

Returns:

An Element by its String identifier.

Throws:

ValidationLayerException - If any error occurs.

getElementByName

public Element getElementByName(String elementName)
                         throws ValidationLayerException

Description copied from interface: ValidationLayer

Gets an element by its String name.

Specified by:

getElementByName in interface ValidationLayer

Parameters:

elementName - The String name of the Element to get.

Returns:

An Element by its String name.

Throws:

ValidationLayerException - If any error occurs.

getElements

public List<Element> getElements(ProductType type,
                        boolean direct)
                          throws ValidationLayerException

Returns the declared elements for a ProductType

Parameters:

type - The ProductType to get the elements for

direct - If false, return elements of the parent product types as well

Returns:

A list of all Element of the Product type

Throws:

ValidationLayerException - If any error occurs

getSubToSuperMap

public HashMap<String,String> getSubToSuperMap()

Gets the parent-child relationship between product types

Returns:

HashMap of ProductType ids mapped to their parent id

addParentForProductType

public void addParentForProductType(ProductType type,
                           String parentId)
                             throws ValidationLayerException

Sets a parentId for an existing ProductType

Parameters:

type - The ProductType to add a parent for

parentId - The id of the parent ProductType

Throws:

ValidationLayerException - If any error occurs

removeParentForProductType

public void removeParentForProductType(ProductType type)
                                throws ValidationLayerException

Removes the parent for a ProductType

Parameters:

type - The ProductType to remove the parent from

Throws:

ValidationLayerException - If any error occurs