VgQuery Class Reference

Classes
class	Operator

Public Member Functions
	VgQuery ()
VgQuery	where (String pKey, VgQuery.Operator pOp, String pValue)
VgQuery	reset ()

Detailed Description

Holds a query that could be executed by the engine.

Warning

Performance note: this query mechanism should not be used intensively.

Version

2.0.9334

See also

VgEngine::VgIEngine::execute

Constructor & Destructor Documentation

VgQuery.VgQuery

(

)

Constructor.

Member Function Documentation

VgQuery VgQuery.reset

(

)

Resets the VgQuery conditions, useful when reusing VgQuery 's

Returns

A reference of itself, allowing calls to be chained.

VgQuery VgQuery.where	(	String	pKey,
		VgQuery.Operator	pOp,
		String	pValue
	)

Adds a condition to the query. If the pKey has already been used replaces the condition for that key. ie lQuery.where("ID",...,"A").where("ID",...,"B") is equivalent to lQuery.where("ID",...,"B")

Example:

...
// Query for an specific ID
...
VgEngine::VgQuery lQuery;
lSpatials = lEngine->execute(lQuery.where("ID",VgEngine::VgQuery::eEquals,"L-250"));
...
// Query all VgPoint
VgEngine::VgQuery lQueryAll;
lSpatials = lEngine->execute(lQueryAll.where("class",VgEngine::VgQuery::eEquals,"Vg3DModule::VgPoint"));
...

Parameters

pKey	Currently, the key can be 'class' or 'ID'.
pOp	The operation to be performed by the query. For the list of available operations, see VgEngine::VgQuery::Operator .
pValue	The value that will be the object of the query operation. When using the key 'class' this value must be the fully qualified name, for example ' Vg3DModule::VgPoint '. Currently, Vg3DModule::VgPoint , Vg3DModule::VgLine , Vg3DModule::VgIGeometry , and VgEngine::VgSpatial can be queried.

Version

2.1.0 Allows for Vg3DModule::VgLine

2.1.3 documented all the classes that are accessible.

See also

VgEngine::VgIEngine::execute for more complete example.

Returns

A reference of itself, allowing calls to be chained.

---

The documentation for this class was generated from the following file:

• VgQuery.java