|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.datacrow.core.services.OnlineSearchHelper
public class OnlineSearchHelper
Simple online search which can run completely in the background.
It has implemented the IOnlineSearchClient
interface. This class can
be used by other processes which want to enable online search (such as the FileImporter
)
Constructor Summary | |
---|---|
OnlineSearchHelper(int module,
int itemMode)
Creates a new instance. |
Method Summary | |
---|---|
void |
addError(java.lang.String message)
Passes an error message to this client. |
void |
addError(java.lang.Throwable t)
Passes an error to this client. |
void |
addMessage(java.lang.String message)
Passes a message to this client. |
void |
addObject(DcObject dco)
Passes a result / item to this client. |
void |
addWarning(java.lang.String warning)
Passes a warning message to this client. |
void |
clear()
Free resources. |
DcObject |
getDcObject()
|
DcModule |
getModule()
Returns the current module. |
void |
processed(int i)
The current result number being processed (x of x). |
void |
processing()
Indicates a task is currently running. |
void |
processingTotal(int i)
Passes the count of results which are going to be processed. |
DcObject |
query(DcObject item)
Queries for new information for the supplied item. |
DcObject |
query(DcObject base,
java.lang.String query,
int[] matcherFieldIdx)
Queries for items and checks if they are similar to the supplied item the item most similar to the base item will be returned. |
java.util.List<DcObject> |
query(java.lang.String query,
DcObject client)
Searches for items based on the provided query string. |
int |
resultCount()
Returns the total count of added items (see IOnlineSearchClient.addObject(DcObject) ) |
void |
setMaximum(int maximum)
The maximum search result. |
void |
setMode(SearchMode mode)
The search mode to be used. |
void |
setRegion(Region region)
The region to be used. |
void |
setServer(IServer server)
The server to be used. |
void |
stopped()
Indicates a task has been stopped and a new task can be started. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public OnlineSearchHelper(int module, int itemMode)
module
- The module indexitemMode
- SearchTask._ITEM_MODE_FULL
or SearchTask._ITEM_MODE_SIMPLE
Method Detail |
---|
public void setServer(IServer server)
server
- public void setRegion(Region region)
region
- public void setMode(SearchMode mode)
mode
- public void setMaximum(int maximum)
maximum
- public DcObject query(DcObject item)
DcObject._SYS_SERVICEURL
).
item
-
public DcObject query(DcObject base, java.lang.String query, int[] matcherFieldIdx)
base
- The item to check the results against.query
- The query to base the search on.matcherFieldIdx
- The field indices used to check for similarity.
public java.util.List<DcObject> query(java.lang.String query, DcObject client)
query
-
public void clear()
except
- Do not clear the resources of this item.public void addError(java.lang.Throwable t)
IOnlineSearchClient
addError
in interface IOnlineSearchClient
public void addError(java.lang.String message)
IOnlineSearchClient
addError
in interface IOnlineSearchClient
public void addMessage(java.lang.String message)
IOnlineSearchClient
addMessage
in interface IOnlineSearchClient
public void addObject(DcObject dco)
IOnlineSearchClient
addObject
in interface IOnlineSearchClient
public void addWarning(java.lang.String warning)
IOnlineSearchClient
addWarning
in interface IOnlineSearchClient
public DcObject getDcObject()
public DcModule getModule()
IOnlineSearchClient
getModule
in interface IOnlineSearchClient
public void processed(int i)
IOnlineSearchClient
processed
in interface IOnlineSearchClient
public void processing()
IOnlineSearchClient
processing
in interface IOnlineSearchClient
public void processingTotal(int i)
IOnlineSearchClient
processingTotal
in interface IOnlineSearchClient
i
- The total count.public int resultCount()
IOnlineSearchClient
IOnlineSearchClient.addObject(DcObject)
)
resultCount
in interface IOnlineSearchClient
public void stopped()
IOnlineSearchClient
stopped
in interface IOnlineSearchClient
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |