Package com.nomagic.reportwizard.tools

Class QueryTool

java.lang.Object

java.util.Observable

com.nomagic.magicreport.engine.Tool

com.nomagic.reportwizard.tools.QueryTool

All Implemented Interfaces:

ITool, IVariable, Serializable, Cloneable

@OpenApiAll
public class QueryTool
extends Tool

The query function for handler query language.

Since:

Jan 28, 2013

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.nomagic.magicreport.engine.ITool

ITool.HTMLString, ITool.RetainedString, ITool.Void

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SORT_TYPE_SORTERTOOL
static final String	SORT_TYPE_SORTTOOL

Fields inherited from class com.nomagic.magicreport.engine.Tool

context, properties

Fields inherited from interface com.nomagic.magicreport.engine.ITool

VOID

Constructor Summary

Constructors

Constructor	Description
QueryTool()	Create the query tool from user selected element scope. This method will user default scope from variable $elements.
QueryTool(Collection<Element> scope)	Create the query tool from specified element scope.

Method Summary

Modifier and Type	Method	Description
Collection<Element>	findSmartPackage()
QueryList	get(String query)	Get elements using query pattern.
QueryList	get(String query, String sortType)	Get elements using query pattern.
Collection<Element>	getChildElements(Element selectedElement)
Element	getElementById(String id)	Retrieve element from selecting package scope whose element ID is exactly equals to given parameter. This method is equivalent to query pattern #id
QueryList	getElementsByName(String name)	Retrieves element from selecting package scope whose element name is exactly equals to given parameter. This method is equivalent to query pattern *[name=var]

Methods inherited from class com.nomagic.magicreport.engine.Tool

clone, getContext, getProperties, getProperty, getProperty, notifyObservers, setContext, setProperties

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.nomagic.magicreport.engine.ITool

clearTool

Field Details

SORT_TYPE_SORTERTOOL

public static final String SORT_TYPE_SORTERTOOL

See Also:

• Constant Field Values

SORT_TYPE_SORTTOOL

public static final String SORT_TYPE_SORTTOOL

See Also:

• Constant Field Values

Constructor Details

QueryTool

public QueryTool()

Create the query tool from user selected element scope.
This method will user default scope from variable $elements.

QueryTool

public QueryTool(Collection<Element> scope)

Create the query tool from specified element scope.

Parameters:

scope - the specified element scope

Method Details

get

public QueryList get(String query)

Get elements using query pattern.

Parameters:

query - the query pattern

Returns:

list of elements

get

public QueryList get(String query,
 String sortType)

Get elements using query pattern.

Parameters:

query - the query pattern

Returns:

list of elements

getElementsByName

public QueryList getElementsByName(String name)

Retrieves element from selecting package scope whose element name is exactly equals to given parameter.
This method is equivalent to query pattern *[name=var]

Parameters:

name - the element name

Returns:

list of MagicDraw Element or empty list if no element matched

getElementById

public Element getElementById(String id)

Retrieve element from selecting package scope whose element ID is exactly equals to given parameter.
This method is equivalent to query pattern #id

Parameters:

id - the element id

Returns:

list of MagicDraw Element or null if no element matched

getChildElements

public Collection<Element> getChildElements(Element selectedElement)

findSmartPackage

public Collection<Element> findSmartPackage()