ambit2.db.search.structure

Class ScopeQuery

java.lang.Object

ambit2.db.search.AbstractQuery<SCOPE,net.idea.modbcum.i.IQueryRetrieval<IStructureRecord>,net.idea.modbcum.q.conditions.EQCondition,IStructureRecord>

ambit2.db.search.structure.ScopeQuery

All Implemented Interfaces:

Serializable, net.idea.modbcum.i.IParameterizedQuery<SCOPE,net.idea.modbcum.i.IQueryRetrieval<IStructureRecord>,net.idea.modbcum.q.conditions.EQCondition>, net.idea.modbcum.i.IQueryObject<IStructureRecord>, net.idea.modbcum.i.IQueryRetrieval<IStructureRecord>, net.idea.modbcum.i.IRetrieval<IStructureRecord>, net.idea.modbcum.i.IStatement

public class ScopeQuery
extends AbstractQuery<SCOPE,net.idea.modbcum.i.IQueryRetrieval<IStructureRecord>,net.idea.modbcum.q.conditions.EQCondition,IStructureRecord>
implements net.idea.modbcum.i.IQueryRetrieval<IStructureRecord>

A convenience class for a query used to restrict the scope of other queries

Author:

nina

See Also:

Serialized Form

Field Summary

Fields inherited from class ambit2.db.search.AbstractQuery

condition, fieldname, id, logger, maxRecords, name, page, selected, value

Fields inherited from interface net.idea.modbcum.i.IQueryRetrieval

NaN

Constructor Summary

Constructors

Constructor and Description
ScopeQuery()
ScopeQuery(SCOPE scope)

Method Summary

Modifier and Type	Method and Description
double	calculateMetric(IStructureRecord object)
IStructureRecord	getObject(ResultSet rs)
List<net.idea.modbcum.i.query.QueryParam>	getParameters()
String	getSQL()
boolean	isPrescreen()
void	setFieldname(SCOPE fieldname)
void	setId(Integer id)
String	toString()

Methods inherited from class ambit2.db.search.AbstractQuery

getCategory, getCondition, getFieldname, getId, getKey, getName, getPage, getPageSize, getValue, isSelected, setCondition, setName, setPage, setPageSize, setSelected, setValue, stringify, supportsPaging, test

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.idea.modbcum.i.IQueryObject

getCategory, getId, getKey, getPage, getPageSize, setPage, setPageSize, supportsPaging

Constructor Detail

ScopeQuery

public ScopeQuery(SCOPE scope)

ScopeQuery

public ScopeQuery()

Method Detail

setFieldname

public void setFieldname(SCOPE fieldname)

Specified by:

setFieldname in interface net.idea.modbcum.i.IParameterizedQuery<SCOPE,net.idea.modbcum.i.IQueryRetrieval<IStructureRecord>,net.idea.modbcum.q.conditions.EQCondition>

Overrides:

setFieldname in class AbstractQuery<SCOPE,net.idea.modbcum.i.IQueryRetrieval<IStructureRecord>,net.idea.modbcum.q.conditions.EQCondition,IStructureRecord>

getParameters

public List<net.idea.modbcum.i.query.QueryParam> getParameters()
                                                        throws net.idea.modbcum.i.exceptions.AmbitException

Specified by:

getParameters in interface net.idea.modbcum.i.IQueryObject<IStructureRecord>

Throws:

net.idea.modbcum.i.exceptions.AmbitException

getSQL

public String getSQL()
              throws net.idea.modbcum.i.exceptions.AmbitException

Specified by:

getSQL in interface net.idea.modbcum.i.IQueryObject<IStructureRecord>

Throws:

net.idea.modbcum.i.exceptions.AmbitException

setId

public void setId(Integer id)

Specified by:

setId in interface net.idea.modbcum.i.IQueryObject<IStructureRecord>

Overrides:

setId in class AbstractQuery<SCOPE,net.idea.modbcum.i.IQueryRetrieval<IStructureRecord>,net.idea.modbcum.q.conditions.EQCondition,IStructureRecord>

getObject

public IStructureRecord getObject(ResultSet rs)
                           throws net.idea.modbcum.i.exceptions.AmbitException

Specified by:

getObject in interface net.idea.modbcum.i.IRetrieval<IStructureRecord>

Throws:

net.idea.modbcum.i.exceptions.AmbitException

toString

public String toString()

Overrides:

toString in class AbstractQuery<SCOPE,net.idea.modbcum.i.IQueryRetrieval<IStructureRecord>,net.idea.modbcum.q.conditions.EQCondition,IStructureRecord>

calculateMetric

public double calculateMetric(IStructureRecord object)

Specified by:

calculateMetric in interface net.idea.modbcum.i.IQueryRetrieval<IStructureRecord>

isPrescreen

public boolean isPrescreen()

Specified by:

isPrescreen in interface net.idea.modbcum.i.IQueryRetrieval<IStructureRecord>