SMILA (incubation) API documentation

org.eclipse.smila.search.lucene.messages.advsearch
Class DAnyFinderAdvSearch

java.lang.Object
  extended by org.eclipse.smila.search.lucene.messages.advsearch.DAnyFinderAdvSearch
All Implemented Interfaces:
java.lang.Cloneable, IAdvSearch

public class DAnyFinderAdvSearch
extends java.lang.Object
implements IAdvSearch

Author:
gschmidt

Constructor Summary
DAnyFinderAdvSearch()
          Constructor.
DAnyFinderAdvSearch(DQueryExpression dQueryExpression)
          Constructs a new AnyFinderAdvancedSearch and adds a QueryExpression.
 
Method Summary
 IQueryExpression addQueryExpression(IQueryExpression dQueryExpression)
          Adds a new QueryExpression to the search query.
 java.lang.Object clone()
          
 boolean equals(java.lang.Object obj)
          Compares the string representations (as obtained by the toString() method) of this object and of the given object.
 IQueryExpression getQueryExpression(int index)
          This method gets a QueryExpression.
 int getQueryExpressionCount()
          
 java.util.Iterator getQueryExpressions()
          
 java.lang.String getVersion()
          Determines the version information for this search query.
 IQueryExpression removeQueryExpression(int index)
          Removes given QueryExpression, represented by its index, from possible search queries..
 IQueryExpression removeQueryExpression(IQueryExpression dQueryExpression)
          Removes given QueryExpression from possible search queries..
 IQueryExpression setQueryExpression(int index, IQueryExpression dQueryExpression)
          Sets a QueryExpression at a given index in this element's list.
 void setVersion(java.lang.String aVersion)
          Sets the version of this search query.
 java.lang.String toString()
          Returns this instance's contents as an XML String.
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DAnyFinderAdvSearch

public DAnyFinderAdvSearch()
Constructor.


DAnyFinderAdvSearch

public DAnyFinderAdvSearch(DQueryExpression dQueryExpression)
Constructs a new AnyFinderAdvancedSearch and adds a QueryExpression.

Parameters:
dQueryExpression - QueryExpression to be added.
Method Detail

clone

public java.lang.Object clone()

Overrides:
clone in class java.lang.Object
Returns:
Object
See Also:
Object.clone()

addQueryExpression

public IQueryExpression addQueryExpression(IQueryExpression dQueryExpression)
Adds a new QueryExpression to the search query.

Specified by:
addQueryExpression in interface IAdvSearch
Parameters:
dQueryExpression - QueryExpression to be added.
Returns:
IQueryExpression

setVersion

public void setVersion(java.lang.String aVersion)
Sets the version of this search query.

Parameters:
aVersion - String representing the version ID.

getVersion

public java.lang.String getVersion()
Determines the version information for this search query.

Returns:
A string representing the version ID.

setQueryExpression

public IQueryExpression setQueryExpression(int index,
                                           IQueryExpression dQueryExpression)
Sets a QueryExpression at a given index in this element's list. Any existing expression at that index will be replaced.

Specified by:
setQueryExpression in interface IAdvSearch
Parameters:
index - index in list where this QueryExpression will be set.
dQueryExpression - QueryExpression to be set at that index.
Returns:
IQueryExpression

getQueryExpression

public IQueryExpression getQueryExpression(int index)
This method gets a QueryExpression.

Specified by:
getQueryExpression in interface IAdvSearch
Parameters:
index - Position of the QueryExpression to be retrieved.
Returns:
IQueryExpression

getQueryExpressions

public java.util.Iterator getQueryExpressions()

Specified by:
getQueryExpressions in interface IAdvSearch
Returns:
Iterator
See Also:
IAdvSearch.getQueryExpressions()

toString

public java.lang.String toString()
Returns this instance's contents as an XML String.

Overrides:
toString in class java.lang.Object
See Also:
Object.toString()

equals

public boolean equals(java.lang.Object obj)
Compares the string representations (as obtained by the toString() method) of this object and of the given object.

Overrides:
equals in class java.lang.Object
Parameters:
obj - Object that this instance should be compared to.
Returns:
boolean

removeQueryExpression

public IQueryExpression removeQueryExpression(IQueryExpression dQueryExpression)
Removes given QueryExpression from possible search queries..

Specified by:
removeQueryExpression in interface IAdvSearch
Parameters:
dQueryExpression - QueryExpression that should be removed.
Returns:
IQueryExpression

removeQueryExpression

public IQueryExpression removeQueryExpression(int index)
Removes given QueryExpression, represented by its index, from possible search queries..

Specified by:
removeQueryExpression in interface IAdvSearch
Parameters:
index - Index of QueryExpression that should be removed.
Returns:
IQueryExpression

getQueryExpressionCount

public int getQueryExpressionCount()

Specified by:
getQueryExpressionCount in interface IAdvSearch
See Also:
IAdvSearch.getQueryExpressionCount()

SMILA (incubation) API documentation