CDMA client API  3.1.0
CDMA core library
org.gumtree.data.dictionary.impl.Path Class Reference

Inherits IPath.

List of all members.

Public Member Functions

 Path (IFactory factory)
 Path (IFactory factory, String path)
String toString ()
String getFactoryName ()
String getValue ()
List< IPathMethod > getMethods ()
void setMethods (List< IPathMethod > methods)
void setValue (String path)
void applyParameters (List< IPathParameter > params)
void removeUnsetParameters ()
void resetParameters ()
Object clone ()
IPathParameter getFirstPathParameter (StringBuffer output)

Public Attributes

final String PARAM_PATTERN = "\\$\\(([^\\)]*)\\)"

Package Attributes

String m_factory
String m_pathValue
String m_pathOrigin
List< IPathMethod > m_methods

Constructor & Destructor Documentation

org.gumtree.data.dictionary.impl.Path.Path ( IFactory  factory,
String  path 
)

Member Function Documentation

void org.gumtree.data.dictionary.impl.Path.applyParameters ( List< IPathParameter >  params)

Will modify the path to make given parameters efficient.

Parameters:
parameterslist of parameters to be inserted

Clone the path so it keep unmodified when updated while it has an occurrence in a dictionary

Returns:
a clone this path
IPathParameter org.gumtree.data.dictionary.impl.Path.getFirstPathParameter ( StringBuffer  output)

Analyze the path to reach the first undefined parameter. Return the path parameter to open the node. The parameter has a wildcard for value (i.e: all matching nodes can be opened)

Parameters:
paramoutput path that will be updated with the appropriate node's type and name until to reach the first path parameter
Returns:
IPathParameter having the right type and name and a wildcard for value (empty)

Getter on methods that should be invoked to get data. The returned list is unmodifiable.

Returns:
unmodifiable list of methods

Get the value of the path

Returns:
string path value

Will modify the path to remove all traces of parameters that are not defined.

Will modify the path to unset all parameters that were defined

void org.gumtree.data.dictionary.impl.Path.setMethods ( List< IPathMethod >  methods)

Set methods that should be invoked to get data. The list contains PathMethod having method and array of Object for arguments.

Parameters:
listthat will be copied to keep it unmodifiable
Returns:
unmodifiable map of methods

Set the value of the path in string

Parameters:
pathstring representation of the targeted node in a IDataset

Returns the String representation of the path.


Member Data Documentation

final String org.gumtree.data.dictionary.impl.Path.PARAM_PATTERN = "\\$\\(([^\\)]*)\\)"

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables