org.collaxa.xml
Interface IBaseFacade

All Superinterfaces:

IFacade

public interface IBaseFacade

extends IFacade

This is the base facade interface provides some basic methods to manipulate the backend XML dom element. All generated facade interfaces extends this interface which provides the developers to directly use the methods defined in this interface.

Since:

2.0

Method Summary

java.lang.String	__getFacadeName() Returns the name of the facade class name.
void	addChildElement(java.lang.String childElementName, java.lang.String namespaceUri, int index, java.lang.Object elementValue) This method IS NOT IMPLEMENTED.
void	addChildElement(java.lang.String childElementName, java.lang.String namespaceUri, java.lang.Object elementValue) Adds this new child element with the given element content.
void	clearChildElements(java.lang.String childElementName, java.lang.String namespaceUri) Clears the contents of the child element.
boolean	containsChildElement(java.lang.String childElementName, java.lang.String namespaceUri) Returns true if the specified child element does exist within the subtree rooted at this facade's root element.
java.lang.String	getAttributeValue(java.lang.String attributeName, java.lang.String namespaceUri) Returns the attribute value for the given attribute name.
org.w3c.dom.Element	getChildElement(java.lang.String childElementName, java.lang.String namespaceUri) Returns the child element for the given child element name.
org.w3c.dom.Element	getChildElement(java.lang.String childElementName, java.lang.String namespaceUri, int index) Returns the child element for the given child element name and the position.
java.util.List	getChildElements(java.lang.String childElementName, java.lang.String namespaceUri) Returns the child elements for the given child element name The list contains children of type org.w3c.dom.Element.
java.lang.String	getChildElementValue(java.lang.String childElementName, java.lang.String namespaceUri) Returns the child element value for the given child element name.
java.lang.String	getChildElementValue(java.lang.String childElementName, java.lang.String namespaceUri, int index) Returns the child element value for the given child element name and the position.
java.lang.String	getSimpleContent()
boolean	isRootElement() Returns true if this is a root element.
boolean	isRootElement(org.w3c.dom.Element element) Check if the given element is a root element or not.
int	numberOfChildElements(java.lang.String childElementName, java.lang.String namespaceUri) Returns the size of children of the given child element name.
java.lang.Object	removeChildElement(java.lang.String childElementName, java.lang.String namespaceUri, int index) Removes the particular child element from this root element.
boolean	removeChildElement(java.lang.String childElementName, java.lang.String namespaceUri, java.lang.Object element) Removes the particular child element from this root element.
void	setAttributeValue(java.lang.String attributeName, java.lang.String namespaceUri, java.lang.Object arributeValue) Sets the new value for the given child attribute.
void	setChildElement(java.lang.String childElementName, java.lang.String namespaceUri, org.w3c.dom.Element newChildElement) Sets the new element value object for the given child element.
void	setChildElementValue(java.lang.String childElementName, java.lang.String namespaceUri, int index, java.lang.String elementValue) Finds the child element for the given element name and set the child element value.
void	setChildElementValue(java.lang.String childElementName, java.lang.String namespaceUri, java.lang.Object elementValue) Sets the new value for the given child element.
void	setChildElementValue(java.lang.String childElementName, java.lang.String namespaceUri, java.lang.String elementValue) Sets the new value for the given child element.
void	setRootElement(org.w3c.dom.Element pElement) Sets the specified DOM element for this facade.
void	setSimpleContent(java.lang.Object obj)
org.w3c.dom.Element	toDOM() Returns the w3c dom element for this facade.

Methods inherited from interface org.collaxa.xml.IFacade

getRootElement

Method Detail

__getFacadeName

public java.lang.String __getFacadeName()

Returns the name of the facade class name.

setRootElement

public void setRootElement(org.w3c.dom.Element pElement)

Sets the specified DOM element for this facade.

getAttributeValue

public java.lang.String getAttributeValue(java.lang.String attributeName,
                                          java.lang.String namespaceUri)

Returns the attribute value for the given attribute name.

Parameters:

attributeName - the attribute name

namespaceUri - the namespace for the attribute

setAttributeValue

public void setAttributeValue(java.lang.String attributeName,
                              java.lang.String namespaceUri,
                              java.lang.Object arributeValue)

Sets the new value for the given child attribute. if the attribute already exists then it will override the value with this new element value. If the attribute doesn't exist then it will automatically creates a new attribute and puts this new value and adds it to the root element.

Parameters:

attributeName - name of the attribute

namespaceUri - namespace uri for the attribute

arributeValue - the value of the attribute

getChildElement

public org.w3c.dom.Element getChildElement(java.lang.String childElementName,
                                           java.lang.String namespaceUri)

Returns the child element for the given child element name.

Parameters:

childElementName - String child element name

namespaceUri - namespace uri for the element

getChildElements

public java.util.List getChildElements(java.lang.String childElementName,
                                       java.lang.String namespaceUri)

Returns the child elements for the given child element name The list contains children of type org.w3c.dom.Element.

Parameters:

childElementName - child element name

namespaceUri - namespace uri for the element

getChildElement

public org.w3c.dom.Element getChildElement(java.lang.String childElementName,
                                           java.lang.String namespaceUri,
                                           int index)

Returns the child element for the given child element name and the position.

Parameters:

childElementName - child element name

namespaceUri - namespace uri for the element

index - position of the element

getChildElementValue

public java.lang.String getChildElementValue(java.lang.String childElementName,
                                             java.lang.String namespaceUri,
                                             int index)

Returns the child element value for the given child element name and the position.

Parameters:

childElementName - child element name

namespaceUri - namespace uri for the element

index - position of the element

getChildElementValue

public java.lang.String getChildElementValue(java.lang.String childElementName,
                                             java.lang.String namespaceUri)

Returns the child element value for the given child element name.

Parameters:

childElementName - child element name

namespaceUri - namespace uri for the element

setChildElementValue

public void setChildElementValue(java.lang.String childElementName,
                                 java.lang.String namespaceUri,
                                 int index,
                                 java.lang.String elementValue)

Finds the child element for the given element name and set the child element value. If there is no element found at the given position, the it will throw a NoSuchElementException.

Parameters:

childElementName - child element name

namespaceUri - namespace uri for the element

index - position where to set the child element value

elementValue - element content that needs to be set

setChildElementValue

public void setChildElementValue(java.lang.String childElementName,
                                 java.lang.String namespaceUri,
                                 java.lang.Object elementValue)

Sets the new value for the given child element. if the child element already exists then it will override the value with this new element value. If the child doesn't exist then it will automatically creates a new element and puts this new value and adds it to the root element.

Parameters:

childElementName - child element name

namespaceUri - namespace uri for the element

elementValue - Object element value

setChildElement

public void setChildElement(java.lang.String childElementName,
                            java.lang.String namespaceUri,
                            org.w3c.dom.Element newChildElement)

Sets the new element value object for the given child element. if the child element already exists then it will override the value with this new element. If the child doesn't exist then it will just adds this new child element it to the root element.

Parameters:

childElementName - child element name

namespaceUri - namespace uri for the element

newChildElement - new child element

setChildElementValue

public void setChildElementValue(java.lang.String childElementName,
                                 java.lang.String namespaceUri,
                                 java.lang.String elementValue)

Sets the new value for the given child element. if the child element already exists then it will override the value with this new element value. If the child doesn't exist then it will automatically creates a new element and puts this new value and adds it to the root element.

Parameters:

childElementName - child element name

namespaceUri - namespace uri for the element

elementValue - string value of element

addChildElement

public void addChildElement(java.lang.String childElementName,
                            java.lang.String namespaceUri,
                            java.lang.Object elementValue)
                     throws java.lang.Exception

Adds this new child element with the given element content. This will create a new element and adds as a child element to this facade's root element.

Parameters:

childElementName - the child element name

namespaceUri - namespace uri for the element

elementValue - Object the element content

Throws:

java.lang.Exception

addChildElement

public void addChildElement(java.lang.String childElementName,
                            java.lang.String namespaceUri,
                            int index,
                            java.lang.Object elementValue)

This method IS NOT IMPLEMENTED. Adds this new child element with the given element content. This will create a new element and adds as a child element to this facade's root element.

Parameters:

childElementName - the child element name

namespaceUri - namespace uri for the element

elementValue - Object the element content

containsChildElement

public boolean containsChildElement(java.lang.String childElementName,
                                    java.lang.String namespaceUri)

Returns true if the specified child element does exist within the subtree rooted at this facade's root element.

Parameters:

childElementName - the child element name

namespaceUri - namespace uri for the element

numberOfChildElements

public int numberOfChildElements(java.lang.String childElementName,
                                 java.lang.String namespaceUri)

Returns the size of children of the given child element name.

Parameters:

childElementName - child element name

namespaceUri - namespace uri for the element

removeChildElement

public boolean removeChildElement(java.lang.String childElementName,
                                  java.lang.String namespaceUri,
                                  java.lang.Object element)

Removes the particular child element from this root element.

Parameters:

childElementName - child element name

namespaceUri - namespace uri for the element

Returns:

true if the element was successfully removed; false if the element could not be found.

removeChildElement

public java.lang.Object removeChildElement(java.lang.String childElementName,
                                           java.lang.String namespaceUri,
                                           int index)

Removes the particular child element from this root element.

Parameters:

childElementName - child element name

namespaceUri - namespace uri for the element

index - the child element position

Returns:

the removed child element

clearChildElements

public void clearChildElements(java.lang.String childElementName,
                               java.lang.String namespaceUri)

Clears the contents of the child element.

Parameters:

childElementName - child element name

namespaceUri - namespace uri for the element

isRootElement

public boolean isRootElement()

Returns true if this is a root element.

isRootElement

public boolean isRootElement(org.w3c.dom.Element element)

Check if the given element is a root element or not.

getSimpleContent

public java.lang.String getSimpleContent()

setSimpleContent

public void setSimpleContent(java.lang.Object obj)

toDOM

public org.w3c.dom.Element toDOM()

Returns the w3c dom element for this facade. This is another version of the getRootElement() method.