com.im.df.api.ddl
Interface DFQuery

All Superinterfaces:

DFItem, DFUserItem, PropertiesEditingConfigurable

public interface DFQuery
extends DFUserItem

Persistent query definition in the system.

Nested Class Summary

Nested classes/interfaces inherited from interface com.im.df.api.ddl.DFItem

DFItem.Handle<T extends DFItem>

Nested classes/interfaces inherited from interface com.im.df.api.support.PropertiesEditingConfigurable

PropertiesEditingConfigurable.Extra

Field Summary

static String

PROP_EXPRESSION

Fields inherited from interface com.im.df.api.ddl.DFItem

PROP_CAPABILITIES, PROP_DESCRIPTION, PROP_ID, PROP_NAME, PROP_TYPE, PROP_VALID

Method Summary

DFDataTree	getDataTree() Get the owner datatree.
DFTermExpression	getExpression() Get the current expression of this query
DFItem.Handle<DFQuery>	getHandle() Returns a handle to the Item.
void	setExpression(DFTermExpression expression, DFEnvironmentRW env) Set new expression value.

Methods inherited from interface com.im.df.api.ddl.DFItem

addPropertyChangeListener, getCapabilities, getDescription, getId, getName, getType, isValid, removePropertyChangeListener, setDescription, setName

Methods inherited from interface com.im.df.api.support.PropertiesEditingConfigurable

isPropertyEditable

Field Detail

PROP_EXPRESSION

static final String PROP_EXPRESSION

See Also:

Constant Field Values

Method Detail

getDataTree

DFDataTree getDataTree()

Get the owner datatree.

Returns:

Datatree which this query belongs to

getExpression

DFTermExpression getExpression()

Get the current expression of this query

Returns:

The expression

setExpression

void setExpression(DFTermExpression expression,
                   DFEnvironmentRW env)

Set new expression value.

Parameters:

expression - New expression to be stored

env - Environment with the appropriate lock

getHandle

DFItem.Handle<DFQuery> getHandle()

Description copied from interface: DFItem

Returns a handle to the Item. The handle uniquely identifies the Item, even though the schema data may be copied or otherwise replicated. Use the Handle instead of DFItem.getId() when registering an Item in collections that extend beyond the DFItem's parent Schema.

Specified by:

getHandle in interface DFItem

Returns:

The handle to the DFItem.