|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sun.portal.search.demo.Search
Search encapsulation class.
Field Summary | |
protected java.lang.String |
database
The comma delimited list of databases to be searched. |
protected int |
firstHit
The first hit to be returned (counting from 1). |
java.lang.String |
proxyDN
|
protected java.lang.String |
query
The fully formatted URL query string that will be sent to the server. |
protected java.lang.String |
queryLanguage
The query language. |
protected java.lang.String |
RDMServer
The RDM server URL |
protected java.lang.String |
RDMType
The RDM request type. |
protected java.lang.String |
scope
The query string. |
protected java.lang.String |
SSOToken
Identity Server Single Sign On token. |
protected java.lang.String |
viewAttributes
The comma delimited requested result attribute list. |
protected int |
viewHits
The maximum number of results requested. |
protected java.lang.String |
viewOrder
The comma delimited sort order w/ +ascending and -descending. |
Constructor Summary | |
Search()
Constructor. |
|
Search(java.lang.String scope,
java.lang.String RDMServer)
Constructor. |
|
Search(java.lang.String scope,
java.lang.String viewAttributes,
java.lang.String viewOrder,
int firstHit,
int viewHits,
java.lang.String queryLanguage,
java.lang.String database,
java.lang.String RDMServer,
java.lang.String ssoToken)
Constructor. |
Method Summary | |
void |
doQuery()
Execute the query. |
void |
doQuery(int firstHit,
int viewHits)
Execute the query, returning viewHits hits starting at firstHit. |
java.lang.String |
getDatabase()
|
int |
getDocumentCount()
The total number of documents available to be searched. |
int |
getFirstHit()
Get the starting hit offset. |
int |
getHitCount()
The total number of results that matched the search. |
java.lang.String |
getProxyDN()
Returns the current target DN for the search. |
java.lang.String |
getQuery()
Return the fully formatted query url sent to the server. |
java.lang.String |
getQueryLanguage()
Returns the current query language. |
SOIF |
getRDMHeaderSOIF()
Return the SOIF RDM result header. |
java.lang.String |
getRDMServer()
Returns the current RDMServer variable. |
java.lang.String |
getRDMType()
Returns the current RDMType. |
int |
getResultCount()
The number of results returned by the search. |
SOIFInputStream |
getResultStream()
Return results as a DataInputStream. |
java.lang.String |
getScope()
Returns the current scope (query) for the search. |
java.lang.String |
getSessionID()
|
int |
getToHit()
Gets the last hit value being displayed |
java.lang.String |
getViewAttributes()
Returns the SOIF attributes which are retrieved by a search. |
int |
getViewHits()
Get the maximum number of hits returned. |
java.lang.String |
getViewOrder()
Gets the sorting order for results. |
boolean |
noHits()
|
void |
setDatabase(java.lang.String database)
|
void |
setFirstHit(int firstHit)
Set the starting hit offset. |
void |
setProxyDN(java.lang.String proxyDN)
Sets the target DN for the search. |
void |
setQueryLanguage(java.lang.String queryLanguage)
Sets the query language. |
void |
setRDMServer(java.lang.String RDMServer)
Sets the RDMServer variable. |
void |
setRDMType(java.lang.String RDMType)
Sets the RDM Request type. |
void |
setScope(java.lang.String scope)
Sets the scope (query) for the search. |
void |
setSessionID(java.lang.String sessID)
|
void |
setSOIFParse(boolean b)
Set whether SOIF parsing is to be done or not. |
void |
setStreamMode(boolean m)
Sets whether streaming is enabled or disabled. |
void |
setViewAttributes(java.lang.String viewAttributes)
Sets the SOIF attributes which are returned for the search. |
void |
setViewHits(int viewHits)
Set the maximum number of hits returned. |
void |
setViewOrder(java.lang.String viewOrder)
Sets the sorting order for results. |
java.lang.String |
toString()
Return debug string version of Search instance. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
protected java.lang.String query
protected java.lang.String scope
protected java.lang.String database
protected java.lang.String RDMServer
protected java.lang.String viewAttributes
protected java.lang.String viewOrder
Eg, "-score,+title". Default value is "-score".
protected java.lang.String SSOToken
protected int viewHits
protected int firstHit
protected java.lang.String RDMType
protected java.lang.String queryLanguage
public java.lang.String proxyDN
Constructor Detail |
public Search()
public Search(java.lang.String scope, java.lang.String RDMServer)
Default values implicit in this constructor are:
- viewAttributes: null. Return all attributes
- viewOrder: null. Return server default (ie, sorted by relevance)
- firsthit: 1. Start hits at hit number 1
- viewhits: 10. Return 10 hits only
- query language: search. Search documents
- database: null. Use the default database for the server
scope
- the query qualificationRDMServer
- Search server URL, eg, http://portal.siroe.com:2222/portal/searchpublic Search(java.lang.String scope, java.lang.String viewAttributes, java.lang.String viewOrder, int firstHit, int viewHits, java.lang.String queryLanguage, java.lang.String database, java.lang.String RDMServer, java.lang.String ssoToken)
scope
- the search queryviewAttributes
- comma delimited desired result attributesviewOrder
- comma delimited sort order w/ +ascend and -descendfirstHit
- first requested hit (numbered from 1)viewHits
- number of results requested (starting with the firstHit result)queryLanguage
- query languagedatabase
- name (can be null for server's default database)RDMServer
- Search server URL, eg, http://portal.siroe.com:2222/portal/searchMethod Detail |
public void setSOIFParse(boolean b)
public void setStreamMode(boolean m)
getResultStream()
to access the document
SOIF DataInputStream directly.
public int getFirstHit()
setFirstHit(int)
public void setFirstHit(int firstHit)
setFirstHit(int)
public int getViewHits()
setViewHits(int)
public void setViewHits(int viewHits)
getViewHits()
public java.lang.String getRDMServer()
public void setRDMServer(java.lang.String RDMServer)
RDMServer
- Search server URL, eg, http://portal.siroe.com:2222/portal/search (Portal server)
http://compass.siroe.com:2222/rdm/incoming (Compass server)public java.lang.String getScope()
setScope(java.lang.String)
public void setScope(java.lang.String scope)
getScope()
public java.lang.String getRDMType()
setRDMType(java.lang.String)
public java.lang.String getProxyDN()
setProxyDN(java.lang.String)
public void setProxyDN(java.lang.String proxyDN)
getProxyDN()
public void setRDMType(java.lang.String RDMType)
RDMType
- Can be one of:
getRDMType()
,
setQueryLanguage(java.lang.String)
public java.lang.String getQueryLanguage()
setQueryLanguage(java.lang.String)
public void setQueryLanguage(java.lang.String queryLanguage)
queryLanguage
- Can be one of:
getQueryLanguage()
,
setRDMType(java.lang.String)
public java.lang.String getViewAttributes()
viewAttributes
as set by setViewAttributes.
A comma delimited list of attributes, returned by a search, egsetViewAttributes(java.lang.String)
public void setViewAttributes(java.lang.String viewAttributes)
viewAttributes
- A null string will return all attributes.
A comma delimited list of attributes is accepted, eggetViewAttributes()
public java.lang.String getViewOrder()
setViewOrder(java.lang.String)
public void setViewOrder(java.lang.String viewOrder)
viewOrder
- A null string will return sorting according to
the server default of -score (descending relevance). A comma delimited
list of attributes is accepted, with + to denote ascending order and - to
denote descending order, eggetViewOrder()
public java.lang.String getQuery()
public void setDatabase(java.lang.String database)
public java.lang.String getDatabase()
public void setSessionID(java.lang.String sessID)
public java.lang.String getSessionID()
public void doQuery()
Note: Query results are concatenated into a single StringBuffer.
Use doQuery(int,int)
to process search results iteratively.
public void doQuery(int firstHit, int viewHits)
public SOIF getRDMHeaderSOIF()
public SOIFInputStream getResultStream()
setStreamMode(boolean)
public int getResultCount()
public int getHitCount()
public int getDocumentCount()
public int getToHit()
public boolean noHits()
public java.lang.String toString()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |