ambit2.db.search.structure
Class ScopeQuery

Package class diagram package ScopeQuery
java.lang.Object
  extended by com.jgoodies.binding.beans.Model
      extended by ambit2.db.search.AbstractQuery<SCOPE,IQueryRetrieval<ambit2.base.interfaces.IStructureRecord>,EQCondition,ambit2.base.interfaces.IStructureRecord>
          extended by ambit2.db.search.structure.ScopeQuery
All Implemented Interfaces:
IStatement, IQueryRetrieval<ambit2.base.interfaces.IStructureRecord>, IRetrieval<ambit2.base.interfaces.IStructureRecord>, IQueryObject<ambit2.base.interfaces.IStructureRecord>, com.jgoodies.binding.beans.Observable, java.io.Serializable

public class ScopeQuery
extends AbstractQuery<SCOPE,IQueryRetrieval<ambit2.base.interfaces.IStructureRecord>,EQCondition,ambit2.base.interfaces.IStructureRecord>
implements IQueryRetrieval<ambit2.base.interfaces.IStructureRecord>

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

See Also:
Serialized Form

Field Summary
 
Fields inherited from class ambit2.db.search.AbstractQuery
condition, fieldname, id, name, selected, value
 
Constructor Summary
ScopeQuery()
           
ScopeQuery(SCOPE scope)
           
 
Method Summary
 double calculateMetric(ambit2.base.interfaces.IStructureRecord object)
           
 ambit2.base.interfaces.IStructureRecord getObject(java.sql.ResultSet rs)
           
 java.util.List<QueryParam> getParameters()
           
 java.lang.String getSQL()
           
 boolean isPrescreen()
           
 void setFieldname(SCOPE fieldname)
           
 void setId(java.lang.Integer id)
           
 java.lang.String toString()
           
 
Methods inherited from class ambit2.db.search.AbstractQuery
getCondition, getFieldname, getId, getMaxRecords, getName, getValue, isSelected, setCondition, setMaxRecords, setName, setSelected, setValue, test
 
Methods inherited from class com.jgoodies.binding.beans.Model
addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, addVetoableChangeListener, equals, fireIndexedPropertyChange, fireIndexedPropertyChange, fireIndexedPropertyChange, fireMultiplePropertiesChanged, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, getPropertyChangeListeners, getPropertyChangeListeners, getVetoableChangeListeners, getVetoableChangeListeners, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, removeVetoableChangeListener
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface ambit2.db.search.IQueryObject
getId, getMaxRecords, setMaxRecords
 

Constructor Detail

ScopeQuery

public ScopeQuery(SCOPE scope)

ScopeQuery

public ScopeQuery()
Method Detail

setFieldname

public void setFieldname(SCOPE fieldname)
Overrides:
setFieldname in class AbstractQuery<SCOPE,IQueryRetrieval<ambit2.base.interfaces.IStructureRecord>,EQCondition,ambit2.base.interfaces.IStructureRecord>

getParameters

public java.util.List<QueryParam> getParameters()
                                         throws ambit2.base.exceptions.AmbitException
Specified by:
getParameters in interface IQueryObject<ambit2.base.interfaces.IStructureRecord>
Throws:
ambit2.base.exceptions.AmbitException

getSQL

public java.lang.String getSQL()
                        throws ambit2.base.exceptions.AmbitException
Specified by:
getSQL in interface IQueryObject<ambit2.base.interfaces.IStructureRecord>
Throws:
ambit2.base.exceptions.AmbitException

setId

public void setId(java.lang.Integer id)
Specified by:
setId in interface IQueryObject<ambit2.base.interfaces.IStructureRecord>
Overrides:
setId in class AbstractQuery<SCOPE,IQueryRetrieval<ambit2.base.interfaces.IStructureRecord>,EQCondition,ambit2.base.interfaces.IStructureRecord>

getObject

public ambit2.base.interfaces.IStructureRecord getObject(java.sql.ResultSet rs)
                                                  throws ambit2.base.exceptions.AmbitException
Specified by:
getObject in interface IRetrieval<ambit2.base.interfaces.IStructureRecord>
Throws:
ambit2.base.exceptions.AmbitException

toString

public java.lang.String toString()
Overrides:
toString in class AbstractQuery<SCOPE,IQueryRetrieval<ambit2.base.interfaces.IStructureRecord>,EQCondition,ambit2.base.interfaces.IStructureRecord>

calculateMetric

public double calculateMetric(ambit2.base.interfaces.IStructureRecord object)
Specified by:
calculateMetric in interface IQueryRetrieval<ambit2.base.interfaces.IStructureRecord>

isPrescreen

public boolean isPrescreen()
Specified by:
isPrescreen in interface IQueryRetrieval<ambit2.base.interfaces.IStructureRecord>