|
SAP NetWeaver 7.31 (SP01) KMC | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.sapportals.wcm.control.released.search.SearchQueryListBuilder
public class SearchQueryListBuilder
The SearchQueryListBuilder provides auxiliary functions for building a search query list for the KM index management API
Copyright 2004 SAP AG
| Constructor Summary | |
|---|---|
SearchQueryListBuilder()
Deprecated. As of NetWeaver 7.1 |
|
SearchQueryListBuilder(Hashtable searchParameters)
Deprecated. As of NetWeaver 7.1 |
|
| Method Summary | |
|---|---|
IQueryEntryList |
buildDidYouMeanQueryEntries(IQueryEntryList oldQuery)
Deprecated. As of NetWeaver 7.1 |
IQueryEntryList |
buildDidYouMeanQueryEntries(IQueryEntryList oldQuery,
String oldTerm,
String didYouMeanTerm)
Deprecated. As of NetWeaver 7.1 |
IQueryEntry |
buildQueryEntryConnector(String connector)
Deprecated. As of NetWeaver 7.1 |
IQueryEntry |
buildQueryEntryDate(IPropertyName propertyName,
Date date,
byte operator)
Deprecated. As of NetWeaver 7.1 |
IQueryEntry |
buildQueryEntryTimeWindow(IPropertyName propertyName,
Date startDate,
Date endDate)
Deprecated. As of NetWeaver 7.1 |
IQueryEntryList |
buildSearchQueryList()
Deprecated. As of NetWeaver 7.1 |
static byte |
getBestSearchAction(String text)
Deprecated. As of NetWeaver 7.1 |
static String |
getDidYouMeanTerm(IQueryEntryList queryEntryList,
String oldSearchTerm)
Deprecated. As of NetWeaver 7.1 |
String |
getSearchAddProps()
Deprecated. As of NetWeaver 7.1 |
String |
getSearchTerm()
Deprecated. As of NetWeaver 7.1 |
String |
getSelectedCustomProps()
Deprecated. As of NetWeaver 7.1 |
String |
getSelectedDescription()
Deprecated. As of NetWeaver 7.1 |
Date |
getSelectedEndDate()
Deprecated. As of NetWeaver 7.1 |
String |
getSelectedItems()
Deprecated. As of NetWeaver 7.1 |
String |
getSelectedNotOlderRange()
Deprecated. As of NetWeaver 7.1 |
String |
getSelectedSearchAction()
Deprecated. As of NetWeaver 7.1 |
String |
getSelectedSimilarTerms()
Deprecated. As of NetWeaver 7.1 |
Date |
getSelectedStartDate()
Deprecated. As of NetWeaver 7.1 |
String |
getSelectedTitle()
Deprecated. As of NetWeaver 7.1 |
String |
getTermConnection()
Deprecated. As of NetWeaver 7.1 |
boolean |
isDescriptionIncluded()
Deprecated. As of NetWeaver 7.1 |
boolean |
isDisplaynameIncluded()
Deprecated. As of NetWeaver 7.1 |
void |
setDescriptionIncluded(boolean value)
Deprecated. As of NetWeaver 7.1 |
void |
setDisplaynameIncluded(boolean value)
Deprecated. As of NetWeaver 7.1 |
void |
setSearchAddProps(String value)
Deprecated. As of NetWeaver 7.1 |
void |
setSearchParameters(Hashtable searchParameters)
Deprecated. As of NetWeaver 7.1 |
void |
setSearchTerm(String searchTerm)
Deprecated. As of NetWeaver 7.1 |
void |
setSelectedCustomProps(String value)
Deprecated. As of NetWeaver 7.1 |
void |
setSelectedDescription(String value)
Deprecated. As of NetWeaver 7.1 |
void |
setSelectedEndDate(Date value)
Deprecated. As of NetWeaver 7.1 |
void |
setSelectedItems(String value)
Deprecated. As of NetWeaver 7.1 |
void |
setSelectedNotOlderRange(String value)
Deprecated. As of NetWeaver 7.1 |
void |
setSelectedSearchAction(String value)
Deprecated. As of NetWeaver 7.1 |
void |
setSelectedSimilarTerms(String value)
Deprecated. As of NetWeaver 7.1 |
void |
setSelectedStartDate(Date value)
Deprecated. As of NetWeaver 7.1 |
void |
setSelectedTitle(String value)
Deprecated. As of NetWeaver 7.1 |
void |
setTermConnection(String value)
Deprecated. As of NetWeaver 7.1 |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public SearchQueryListBuilder()
SearchQueryListBuilder
public SearchQueryListBuilder(Hashtable searchParameters)
setSearchParameters for detailed information.
searchParameters - new SearchParameters tablesetSearchParameters(java.util.Hashtable),
buildSearchQueryList()| Method Detail |
|---|
public void setSearchTerm(String searchTerm)
SearchTerm attribute for the query entry list to be built.
This SearchTerm will be used for searching in the following properties:
setDisplaynameIncluded)
setDescriptionIncluded)
setSearchAddProps)
searchTerm - new SearchTerm for the "standard" search requestgetSearchTerm(),
setDisplaynameIncluded(boolean),
setDescriptionIncluded(boolean),
setSearchAddProps(java.lang.String),
isDisplaynameIncluded(),
isDescriptionIncluded(),
getSearchAddProps()public String getSearchTerm()
SearchTerm that will be recognized when building the query entry list.
SearchTerm
setSearchTerm(java.lang.String)public void setSelectedItems(String value)
SearchParamConst.ITEM_ALL
SearchParamConst.ITEM_ONLY_FOLDERS
SearchParamConst.ITEM_ONLY_DOCS
SearchParamConst.ITEM_NO_FOLDERS
value - new SelectedItems attributegetSelectedItems()public String getSelectedItems()
SelectedItems attribute that will be recognized when building the query entry list.
SelectedItems attributesetSelectedItems(java.lang.String)public void setSelectedStartDate(Date value)
SelectedStartDate attribute that will be recognized as the start date when building the
query entry list for the date properties 'Modified' (cm_modified) and 'Created'.
(cm_created) connected by OR.
SelectedStartDate and SelectedEndDate both need to be set.
buildQueryEntryTimeWindow directly.
value - new SelectedStartDate attributegetSelectedStartDate(),
setSelectedEndDate(java.util.Date),
getSelectedEndDate(),
buildQueryEntryTimeWindow(com.sapportals.wcm.repository.IPropertyName, java.util.Date, java.util.Date)public Date getSelectedStartDate()
SelectedStartDate attribute that will be recognized when building the query entry list.
SelectedStartDate attributesetSelectedStartDate(java.util.Date),
setSelectedEndDate(java.util.Date),
getSelectedEndDate(),
buildQueryEntryTimeWindow(com.sapportals.wcm.repository.IPropertyName, java.util.Date, java.util.Date)public void setSelectedEndDate(Date value)
SelectedEndDate attribute that will be recognized as the end date when building the
query entry list for the date properties 'Modified' (cm_modified) and 'Created'.
(cm_created) connected by OR.
The attributes SelectedStartDate and SelectedEndDate both need to be set.
buildQueryEntryTimeWindow directly.
value - new SelectedStartDate attributegetSelectedEndDate(),
setSelectedStartDate(java.util.Date),
getSelectedStartDate(),
buildQueryEntryTimeWindow(com.sapportals.wcm.repository.IPropertyName, java.util.Date, java.util.Date)public Date getSelectedEndDate()
SelectedEndDate attribute that will be recognized
when building the query entry list.
SelectedEndDate attributesetSelectedEndDate(java.util.Date),
setSelectedStartDate(java.util.Date),
getSelectedStartDate(),
buildQueryEntryTimeWindow(com.sapportals.wcm.repository.IPropertyName, java.util.Date, java.util.Date)public void setSelectedSearchAction(String value)
SearchParamConst.ACTION_FUZZY
SearchParamConst.ACTION_EXACT
SearchParamConst.ACTION_LINGUISTIC
SearchParamConst.ACTION_AUTOMATIC
AUTOMATIC).
value - new SelectedSearchAction attributegetBestSearchAction(java.lang.String),
getSelectedSearchAction(),
setSearchTerm(java.lang.String)public String getSelectedSearchAction()
SelectedSearchAction attributegetBestSearchAction(java.lang.String),
setSelectedSearchAction(java.lang.String),
setSearchTerm(java.lang.String)public void setSearchAddProps(String value)
setSearchTerm) will be searched for additionally.
With standard, only content, description, and the display name are searched for.
Specify multiple properties as a comma-separated list of unique property IDs.
createdby,modifiedby,embedded-keywords
searchAddProps - - new SearchAddProps attributegetSearchAddProps(),
setSearchTerm(java.lang.String)public String getSearchAddProps()
setSearchAddProps(java.lang.String),
setSearchTerm(java.lang.String)public void setSelectedCustomProps(String value)
AND.
OR.
selectedCustomProps - new SelectedCustomProps attributegetSelectedCustomProps()public String getSelectedCustomProps()
SelectedCustomProps attributesetSelectedCustomProps(java.lang.String)public void setSelectedNotOlderRange(String value)
SearchParamConst.NOT_OLDER_NONE - no query entry is built
SearchParamConst.NOT_OLDER_TODAY
SearchParamConst.NOT_OLDER_WEEK
SearchParamConst.NOT_OLDER_MONTH
SearchParamConst.NOT_OLDER_3_MONTHS
selectedNotOlderRange - new SelectedNotOlderRange attributegetSelectedNotOlderRange()public String getSelectedNotOlderRange()
SelectedNotOlderRange attributesetSelectedNotOlderRange(java.lang.String)public void setSelectedTitle(String value)
Text), display name (String), access-Uri (String).
The properties that are taken into account during the search are decided by the occurrence of the generic
symbol "*" and an extension symbol ".".
String) and access-uri
String) and display name (Text)
OR.
Search method for search on display name (Text) is taken from the
preset value. If no method is specified, 'best practice' is used.
Text) is taken from the
preset value. If no method is specified, 'best practice' is used.
selectedTitle - new SelectedTitle attributegetSelectedTitle(),
setSelectedSearchAction(java.lang.String)public String getSelectedTitle()
SelectedTitle attributesetSelectedTitle(java.lang.String)public void setSelectedDescription(String value)
Text) is taken from the
preset value. If no method is specified, 'best practice' is used.
selectedDescription - - new SelectedDescription attributegetSelectedDescription(),
setSelectedSearchAction(java.lang.String)public String getSelectedDescription()
SelectedDescriptionsetSelectedDescription(java.lang.String)public void setSelectedSimilarTerms(String value)
value - new SelectedSimilarTerms attributegetSelectedSimilarTerms()public String getSelectedSimilarTerms()
SelectedDescription attributesetSelectedSimilarTerms(java.lang.String)public void setDisplaynameIncluded(boolean value)
value - new DisplaynameIncluded flagisDisplaynameIncluded(),
setSearchTerm(java.lang.String)public boolean isDisplaynameIncluded()
DisplaynameIncluded flagsetDisplaynameIncluded(boolean),
setSearchTerm(java.lang.String)public void setDescriptionIncluded(boolean value)
value - new DescriptionIncluded flagisDescriptionIncluded(),
setSearchTerm(java.lang.String)public boolean isDescriptionIncluded()
DescriptionIncluded flagsetDescriptionIncluded(boolean),
setSearchTerm(java.lang.String)public void setTermConnection(String value)
TermConnections the search term queries are connected in different ways.
value - new TermConnection modegetTermConnection()public String getTermConnection()
TermConnectionsetTermConnection(java.lang.String)public void setSearchParameters(Hashtable searchParameters)
SearchParamConst.PARAM_SEARCH_TERM (String)
SearchParamConst.PARAM_SEARCH_ADD_PROPS (String)
SearchParamConst.PARAM_CUSTOM_PROPS (String)
SearchParamConst.PARAM_DESCRIPTION (String)
SearchParamConst.PARAM_NOT_OLDER_RANGE (String)
SearchParamConst.PARAM_TITLE (String)
SearchParamConst.PARAM_SEARCH_ACTION (String)
SearchParamConst.PARAM_SIMILAR_TERMS (String)
SearchParamConst.PARAM_ITEMS_SELECTION (String)
searchParameters - new SearchParameters tablegetSearchTerm(),
getSearchAddProps(),
getSelectedCustomProps(),
getSelectedNotOlderRange(),
getSelectedTitle(),
getSelectedDescription(),
getSelectedSearchAction(),
getSelectedSimilarTerms(),
getSelectedItems()
public IQueryEntryList buildSearchQueryList()
throws com.sapportals.wcm.WcmException
SearchQueryListBuilder searchQueryListBuilder = new searchQueryListBuilder();
searchQueryListBuilder.setSearchTerm(mySearchTerm);
IQueryEntryList queryEntryList = searchQueryListBuilder.buildSearchQueryEntryList();
com.sapportals.wcm.WcmExceptionSearchQueryListBuilder(java.util.Hashtable)
public IQueryEntryList buildDidYouMeanQueryEntries(IQueryEntryList oldQuery,
String oldTerm,
String didYouMeanTerm)
throws com.sapportals.wcm.WcmException
buildDidYouMeanQueryEntries with different entry parameter
oldQuery - old query entry listoldTerm - old search termdidYouMeanTerm - new "Did you mean term"
com.sapportals.wcm.WcmExceptiongetDidYouMeanTerm(com.sapportals.wcm.service.indexmanagement.retrieval.search.IQueryEntryList, java.lang.String)
public IQueryEntryList buildDidYouMeanQueryEntries(IQueryEntryList oldQuery)
throws com.sapportals.wcm.WcmException
oldQuery - old query entry list
com.sapportals.wcm.WcmExceptiongetDidYouMeanTerm(com.sapportals.wcm.service.indexmanagement.retrieval.search.IQueryEntryList, java.lang.String)
public IQueryEntry buildQueryEntryTimeWindow(IPropertyName propertyName,
Date startDate,
Date endDate)
throws com.sapportals.wcm.WcmException
startDate and endDate need to be set.
AND or OR.
propertyName - KM property name object that specifies attribute to be searched forstartDate - starting date of time windowendDate - ending date of time window
com.sapportals.wcm.WcmExceptionbuildQueryEntryDate(com.sapportals.wcm.repository.IPropertyName, java.util.Date, byte)
public IQueryEntry buildQueryEntryDate(IPropertyName propertyName,
Date date,
byte operator)
throws com.sapportals.wcm.WcmException
AND or OR.
propertyName - KM property name object that specifies attribute to be searched fordate - valueoperator - value reffering IQueryEntry-operatores like eg IQueryEntry.PROPERTY_OPERATOR_GREATER.
buildQueryEntryTimeWindow.
com.sapportals.wcm.WcmExceptionbuildQueryEntryTimeWindow(com.sapportals.wcm.repository.IPropertyName, java.util.Date, java.util.Date)public static byte getBestSearchAction(String text)
EXACT for wildcards, quotation marks at start and end
or only capital and non-lingustic chars (for example ABC$�&/())
LINGUSITIC for at least one lingustic meaningful char (for example, abc)
setSelectedSearchAction with
the parameter value SearchParamConst.ACTION_AUTOMATIC.
text - search term
setSelectedSearchAction(java.lang.String),
getSelectedSearchAction()
public static String getDidYouMeanTerm(IQueryEntryList queryEntryList,
String oldSearchTerm)
throws com.sapportals.wcm.WcmException
buildDidYouMeanQueryEntries.
queryEntryList - old query entry listoldSearchTerm - old search term
com.sapportals.wcm.WcmExceptionbuildDidYouMeanQueryEntries(com.sapportals.wcm.service.indexmanagement.retrieval.search.IQueryEntryList, java.lang.String, java.lang.String)
public IQueryEntry buildQueryEntryConnector(String connector)
throws com.sapportals.wcm.WcmException
IQueryEntry.OPERATOR_AND - AND connection
IQueryEntry.OPERATOR_OR - OR connection
IQueryEntry.OPERATOR_NOT - NOT connection
...
SearchQueryListBuilder searchQueryListBuilder = new searchQueryListBuilder();
IQueryEntry queryEntryConnector = searchQueryListBuilder.buildQueryEntryConnector(IQueryEntry.OPERATOR_AND);
queryEntryList1.add(queryEntryConnector);
queryEntryList1.addAll(queryEntryList2);
...
connector - Sting constant that specifies the connection operator (for exmample OR)
com.sapportals.wcm.WcmExceptionbuildSearchQueryList()| Access Rights |
|---|
| SC | DC | Public Part | ACH |
|---|---|---|---|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
[sap.com] KMC-CM
|
[sap.com]
|
api
|
EP-KM-CM
|
|
SAP NetWeaver 7.31 (SP01) KMC | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||