|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectmessif.operations.AbstractOperation
messif.operations.QueryOperation<RankedAbstractObject>
messif.operations.RankingQueryOperation
messif.operations.query.GetObjectsByLocatorsOperation
public class GetObjectsByLocatorsOperation
This operation returns objects with given locators.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class messif.operations.AbstractOperation |
---|
AbstractOperation.DataEqualOperation, AbstractOperation.OperationConstructor, AbstractOperation.OperationName |
Field Summary | |
---|---|
protected java.util.Set<java.lang.String> |
locators
The locators of the desired objects |
protected LocalAbstractObject |
queryObjectForDistances
The object to compute distances to; if null, UNKNOWN_DISTANCE will be used in answer |
Fields inherited from class messif.operations.QueryOperation |
---|
answerType |
Fields inherited from class messif.operations.AbstractOperation |
---|
errValue, operID, suppData |
Constructor Summary | |
---|---|
GetObjectsByLocatorsOperation()
Create a new instance of GetObjectsByLocatorsOperation with an empty locators set. |
|
GetObjectsByLocatorsOperation(java.util.Collection<java.lang.String> locators)
Create a new instance of GetObjectsByLocatorsOperation with the specified locators. |
|
GetObjectsByLocatorsOperation(java.util.Collection<java.lang.String> locators,
LocalAbstractObject queryObjectForDistances)
Create a new instance of GetObjectsByLocatorsOperation with the specified locators. |
|
GetObjectsByLocatorsOperation(java.util.Collection<java.lang.String> locators,
LocalAbstractObject queryObjectForDistances,
AnswerType answerType)
Create a new instance of GetObjectsByLocatorsOperation with the specified locators. |
|
GetObjectsByLocatorsOperation(java.util.Collection<java.lang.String> locators,
LocalAbstractObject queryObjectForDistances,
AnswerType answerType,
int maxAnswerSize)
Create a new instance of GetObjectsByLocatorsOperation with the specified locators. |
|
GetObjectsByLocatorsOperation(LocalAbstractObject queryObjectForDistances,
AnswerType answerType)
Create a new instance of GetObjectsByLocatorsOperation with empty locators set. |
|
GetObjectsByLocatorsOperation(LocalAbstractObject queryObjectForDistances,
AnswerType answerType,
int maxAnswerCount)
Create a new instance of GetObjectsByLocatorsOperation with empty locators set. |
|
GetObjectsByLocatorsOperation(LocalAbstractObject queryObjectForDistances,
int maxAnswerCount)
Create a new instance of GetObjectsByLocatorsOperation with empty locators set. |
Method Summary | |
---|---|
void |
addLocator(java.lang.String locator)
Add a locator to this query. |
void |
clearSurplusData()
Clear non-messif data stored in operation. |
protected boolean |
dataEqualsImpl(AbstractOperation obj)
Indicates whether some other operation has the same data as this one. |
int |
dataHashCode()
Returns a hash code value for the data of this operation. |
int |
evaluate(AbstractObjectIterator<? extends LocalAbstractObject> objects)
Evaluate this query on a given set of objects. |
java.lang.Class<? extends RankedAbstractObject> |
getAnswerClass()
Returns the class of objects this operation stores in its answer. |
java.lang.Object |
getArgument(int index)
Returns argument that was passed while constructing instance. |
int |
getArgumentCount()
Returns number of arguments that were passed while constructing this instance. |
java.util.Set<java.lang.String> |
getLocators()
Returns the object locators this query searches for. |
LocalAbstractObject |
getQueryObject()
Returns the object the distance to which is used for the answer rank. |
boolean |
hasLocator(java.lang.String locator)
Check whether the set of locators contains given locator. |
void |
setLocators(java.util.Collection<java.lang.String> locators)
Replace the current locators of this query with the provided collection. |
Methods inherited from class messif.operations.RankingQueryOperation |
---|
addToAnswer, addToAnswer, clone, getAnswer, getAnswer, getAnswerCount, getAnswerDistance, getAnswerObjects, getAnswerThreshold, getLastAnswer, isAnswerFull, isStoringMetaDistances, resetAnswer, setAnswerCollection, updateFrom, updateFrom |
Methods inherited from class messif.operations.QueryOperation |
---|
appendErrorCode, endOperation, getAnswerType, wasSuccessful |
Methods inherited from class messif.operations.AbstractOperation |
---|
appendArguments, createOperation, dataEquals, endOperation, equals, getAnnotatedConstructor, getAnnotatedConstructor, getConstructorArgumentDescriptions, getConstructorArgumentDescriptions, getConstructorArguments, getConstructorArguments, getConstructorDescription, getErrorCode, getName, getName, getOperationID, hashCode, isFinished, toString |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected final java.util.Set<java.lang.String> locators
protected final LocalAbstractObject queryObjectForDistances
Constructor Detail |
---|
public GetObjectsByLocatorsOperation(java.util.Collection<java.lang.String> locators, LocalAbstractObject queryObjectForDistances, AnswerType answerType, int maxAnswerSize)
locators
- the collection of locators to be foundqueryObjectForDistances
- the query object to use for computing distancesanswerType
- the type of objects this operation stores in its answermaxAnswerSize
- the limit for the number of objects kept in this operation's answerpublic GetObjectsByLocatorsOperation(java.util.Collection<java.lang.String> locators, LocalAbstractObject queryObjectForDistances, AnswerType answerType)
locators
- the collection of locators to be foundqueryObjectForDistances
- the query object to use for computing distancesanswerType
- the type of objects this operation stores in its answerpublic GetObjectsByLocatorsOperation(java.util.Collection<java.lang.String> locators, LocalAbstractObject queryObjectForDistances)
locators
- the collection of locators to be foundqueryObjectForDistances
- the query object to use for computing distancespublic GetObjectsByLocatorsOperation(java.util.Collection<java.lang.String> locators)
locators
- the collection of locators to search forpublic GetObjectsByLocatorsOperation()
public GetObjectsByLocatorsOperation(LocalAbstractObject queryObjectForDistances, AnswerType answerType, int maxAnswerCount)
queryObjectForDistances
- the query object to use for computing distancesanswerType
- the type of objects this operation stores in its answermaxAnswerCount
- the limit for the number of objects kept in this operation's answerpublic GetObjectsByLocatorsOperation(LocalAbstractObject queryObjectForDistances, AnswerType answerType)
queryObjectForDistances
- the query object to use for computing distancesanswerType
- the type of objects this operation stores in its answerpublic GetObjectsByLocatorsOperation(LocalAbstractObject queryObjectForDistances, int maxAnswerCount)
queryObjectForDistances
- the query object to use for computing distancesmaxAnswerCount
- the limit for the number of objects kept in this operation's answerMethod Detail |
---|
public java.lang.Object getArgument(int index) throws java.lang.IndexOutOfBoundsException
getArgument
in class AbstractOperation
index
- index of an argument passed to constructor
java.lang.IndexOutOfBoundsException
- if index parameter is out of rangepublic int getArgumentCount()
getArgumentCount
in class AbstractOperation
public LocalAbstractObject getQueryObject()
public java.util.Set<java.lang.String> getLocators()
public void addLocator(java.lang.String locator)
locator
- the locator to be addedpublic void setLocators(java.util.Collection<java.lang.String> locators)
locators
- the new collection of locatorspublic boolean hasLocator(java.lang.String locator)
locator
- the locator to be checked
true
if the set of locators to be found contains the given locator
public int evaluate(AbstractObjectIterator<? extends LocalAbstractObject> objects)
RankingQueryOperation.addToAnswer(messif.objects.LocalAbstractObject, messif.objects.LocalAbstractObject, float)
.
evaluate
in class QueryOperation<RankedAbstractObject>
objects
- the collection of objects on which to evaluate this query
java.lang.IllegalArgumentException
- if the object cannot be added to the answer, e.g. because it cannot be clonnedpublic java.lang.Class<? extends RankedAbstractObject> getAnswerClass()
getAnswerClass
in class RankingQueryOperation
public void clearSurplusData()
clearSurplusData
in interface Clearable
clearSurplusData
in class RankingQueryOperation
protected boolean dataEqualsImpl(AbstractOperation obj)
dataEqualsImpl
in class AbstractOperation
obj
- the reference object with which to compare.
true
if this object has the same data as the obj
argument; false
otherwise.public int dataHashCode()
dataHashCode
in class AbstractOperation
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |