com.vhosting.netconf
Class SubtreeFilter

java.lang.Object
  extended by com.vhosting.netconf.SubtreeFilter

public class SubtreeFilter
extends java.lang.Object

This class represents a SubtreeFilter. A SubtreeFilter is a special filter used to be able to select the data when using operations that require the return of data.

Version:
1.00, 02/11/2010
Author:
Giuseppe Palmeri

Nested Class Summary
 class SubtreeFilter.Filter
          This class identifies a filter contained within a SubtreeFilter.
 
Constructor Summary
SubtreeFilter(Anyxml anyxml)
          Create a subtree filter starting from the instance of a type element Anyxml.
 
Method Summary
 SubtreeFilter.Filter addFilter(Capability cap)
          Add a filter to the subtreefilter.
 org.w3c.dom.Document createAnyxmlValue()
          Create a valid XML document as an argument for the Anyxml element passed to the constructor.
 SubtreeFilter.Filter[] getFilters()
          Get all the filters setup.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SubtreeFilter

public SubtreeFilter(Anyxml anyxml)
Create a subtree filter starting from the instance of a type element Anyxml. The value to assign for this Anyxml will be the filter.

Parameters:
anyxml - The Anyxml element.
See Also:
createAnyxmlValue()
Method Detail

addFilter

public SubtreeFilter.Filter addFilter(Capability cap)
Add a filter to the subtreefilter. The created filter is empty and to be present, must be populated.

Parameters:
cap - The capability they belong to the filtered data.
Returns:
An instance for the filter you just created.

getFilters

public SubtreeFilter.Filter[] getFilters()
Get all the filters setup.

Returns:
The filters setup.

createAnyxmlValue

public org.w3c.dom.Document createAnyxmlValue()
Create a valid XML document as an argument for the Anyxml element passed to the constructor.

Returns:
The XML document.