public abstract class AbstractIndex extends Object implements IIndex
AbstractIndex.ReindexerWithoutClear
convertStringPropertiesToObjects(List)
getClassProperties()
getDocumentFeaturesPropName()
getHighlightedContent(ISearchResultList, IQueryEntryList)
getHighlightedContent(ISearchResultList, IQueryEntryList, boolean)
getIndexOnlyPropertiesPropName()
getIndexedProperties(List, IMutablePropertyMap)
getLogicalOrPhysicalPropName()
getModeledPropertyIndexType(IPropertyName)
getNumberOfIndexErrors(RID)
getPropertiesAsStrings()
IIndex.getResourceInfo(IResource)
getSimilarClasses(IPropertyName, String, int)
indexExistsAndReadyForDeleteOrClear()
isInSystemFolder(RID)
isLogicalVariant(IResource)
isPhysicalVariant(IResource)
onlyVirtualDatasources()
reindexWithoutClear()
setClassProperties(HashSet)
setQueryExtender(DefaultQueryExtender)
startReindexerWithoutClear()
unescape(String, char)
IIndex
Modifier and Type | Class and Description |
---|---|
static class |
AbstractIndex.ErrorState |
static class |
AbstractIndex.IndexingState |
class |
AbstractIndex.Reindexer
This class handles the reindex process in a separate thread.
|
class |
AbstractIndex.ReindexerWithoutClear
This class handles the reindex process without clearin the index in a separate thread.
|
static class |
AbstractIndex.RunningState |
static class |
AbstractIndex.WhatToIndex |
Modifier and Type | Field and Description |
---|---|
static String |
AS_STRING |
static String |
CFG_PLUGIN_CM_INDEXES |
static String |
CFG_PLUGIN_CM_INDEXES_INDEX_FOLDERS |
static String |
INDEX_ALSO_AS_STRING |
static String |
INDEX_STRING_AS_STRING |
protected String |
m_crawlerProfileId
ID of the default crawler profile for all index folders of the index.
|
protected IIndexFolderList |
m_indexFolders
list of index folders that are assigned to the index
|
protected String |
m_indexGroup
group of the index
|
protected String |
m_indexId
id of the index
|
protected String |
m_indexName
display name of the index
|
protected boolean |
m_isActive
Indicates if an index is available or has be deactivated.
|
protected String |
m_serviceId
the id of the implementing index service
|
protected static String |
m_serviceUserId
ID of the service user.
|
static String |
PROPERTIES |
Constructor and Description |
---|
AbstractIndex(String indexId,
String indexName,
String indexGroup,
IIndexFolderList indexFolders,
String serviceId,
String serviceUserId,
Properties indexServiceProperties)
Deprecated.
as of NW04. Use constructor with crawler profile ID
|
AbstractIndex(String indexId,
String indexName,
String indexGroup,
IIndexFolderList indexFolders,
String serviceId,
String crawlerProfileId,
String serviceUserId,
Properties indexServiceProperties)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
addFolderUri(URI folderUri)
Deprecated.
as of NW04. Use add(IIndexFolder) at the IIndexFolderList interface
|
List |
changeIndexedDocumentProperties(RID rid,
IPropertyMap addProperties,
IPropertyMap deleteProperties,
IPropertyMap defineProperties)
If supported by the search engine (e.g. supported by Trex), this method allows to set
property values of indexed documents directly on the server.
|
void |
changeIndexedDocumentProperties(RID rid,
IPropertyMap addProperties,
IPropertyMap deleteProperties,
IPropertyNameList deleteValues,
boolean testQueue)
This method adds and deletes property values for a particular resource on the index server.
|
void |
changeIndexedDocumentProperties(RID rid,
IPropertyMap addProperties,
IPropertyMap deleteProperties,
IPropertyNameList deleteValues,
IProperty testProperty)
This method adds and deletes property values for a particular resource on the index server.
|
void |
checkIndexIsActive()
checks if index is active.
|
void |
checkProperties(Properties customProperties)
Executes some consistency checks on the properties.
|
void |
clearPropertiesCache()
This method informs a search plug-in to clear its custom properties cache
|
int |
compareTo(Object o)
Compares two indexes
|
static Date |
convertDateToIndexTime(Date dateInput)
Converts the input date into a date used for indexing time attribute and returns this value.
|
Properties |
convertStringPropertiesToObjects(List stringProperties) |
void |
createIndexOnServer()
Creates the index on the index server connected with the CM system.
|
void |
deindex(IQueryEntryList query)
This method deindexes all resources from the index server fullfilling the query.
|
void |
deindexDocument(IResource resource)
Deindexes a document
|
void |
deindexDocument(RID resourceRid)
Deindexes a document
|
void |
deindexDocument(URI resourceUri)
Deprecated.
as of NW04. Use deindexDocument(RID)
|
void |
deindexDocuments(IResourceList resources)
Deindexes a document
|
void |
deindexDocuments(IRidList resourceRids)
Deindexes a document
|
void |
deindexDocuments(IUriList resourceUris)
Deprecated.
as of NW04. Use deindexDocuments(IRidList)
|
void |
deleteOnServer()
Deletes the index on the index server connected with the CM system.
|
static void |
deleteOnServer(String indexId) |
void |
deltaReindex()
Performs indexing of the documents that are not indexed yet or have been changed since the last crawl.
|
boolean |
equals(Object o) |
static StringBuffer |
escape(String s) |
static StringBuffer |
escape(String s,
char par) |
void |
flush()
Flushes the queue
|
boolean |
flush(RID rid,
int counter) |
void |
flushAsync()
Asynchronous flush.
|
void |
flushAsync(RID rid,
int counter)
Asynchronous flush.
|
long |
getActiveTime()
Gives a rough estimation for the time duration needed for indexing the actual available documents.
|
HashSet |
getClassProperties() |
IContent |
getContent(RID rid) |
String |
getCrawlerProfileId()
ID of the default crawler profile for all index folders of the index.
|
String |
getDetailsMonitorPageText(Locale locale)
Get Display Text for details monitor portal page
|
String |
getDetailsMonitorPageURL() |
String |
getDetailsMonitorURL1() |
String |
getDetailsMonitorURL2() |
String |
getDetailsMonitorURL3() |
static PropertyName |
getDisplayNameAsStringPropName() |
static PropertyName |
getDocumentFeaturesPropName() |
AbstractIndex.ErrorState |
getErrorState(double errorThreshold,
double warningThreshold,
Locale locale) |
IUriList |
getFolderUris()
Deprecated.
as of NW04. Use getFolderRids()
|
String[] |
getFrameSizes()
Get frame sizes of detailed monitors (and implicit number of detailed monitors)
|
RID |
getHiddenIndexAreaStartRid() |
static Map |
getHiddenIndexIds()
only for internal usage
|
Collection |
getHighlightedContent(ISearchResultList searchResults,
IQueryEntryList queryList)
gets the hightlighted content of resources with respect to the queryList
|
Collection |
getHighlightedContent(ISearchResultList searchResults,
IQueryEntryList queryList,
boolean anchorlinks)
gets the hightlighted content of resources with respect to the queryList
|
IPropertyMap |
getIndexedProperties()
Returns the properties, indexed with the documents in the index.
|
void |
getIndexedProperties(List indexList,
IMutablePropertyMap returnMap)
Adds the properties in the indexes to the property map.
|
IIndexFolder |
getIndexFolderForDocument(RID documentRid)
Gets the next upper indexFolder for the document
|
static PropertyName |
getIndexFolderRidPropName() |
IIndexFolderList |
getIndexFolders()
Folders or start pages that are assigned to the index for indexing.
|
String |
getIndexGroup()
Returns the group of indexes to which the index logically belongs.
|
String |
getIndexId()
Identifies the index within the system.
|
AbstractIndex.IndexingState |
getIndexingState()
Returns the current state of the index.
|
String |
getIndexName()
Non-technical identifier of an index.
|
static PropertyName |
getIndexOnlyPropertiesPropName() |
List |
getLanguagesOfIndexedDocuments()
Returns the languages of an index, for which documents exist in.
|
Set |
getLanguagesOfIndexedDocuments(List indexes)
Returns the languages of the indexes, for which documents exist in.
|
static PropertyName |
getLogicalOrPhysicalPropName() |
static byte |
getModeledPropertyIndexType(IMetaName metaName) |
static byte |
getModeledPropertyIndexType(IPropertyName propName) |
int |
getNumberOfCrawler(RID indexRid)
Only for internal usage.
|
int |
getNumberOfDocumentsInQueue() |
int |
getNumberOfErrors() |
int |
getNumberOfIndexedDocuments(IIndexFolder indexFolder,
IResourceContext context)
Returns the number of documents of the data source of the index which are already in the index
|
int |
getNumberOfIndexErrors(RID startRid) |
int |
getNumberOfSuccessfullyIndexedDocs()
Returns the numbers of documents successfully indexed and searchable.
|
Collection |
getOriginalContent(IRidList ridList)
Returns the content for the specified ridList.
|
Properties |
getProperties()
Gets index implementation specific data
|
Map |
getPropertiesAsStrings() |
IPropertyMap |
getPropertiesForHiddenResource(RID rid) |
DefaultQueryExtender |
getQueryExtender()
Deprecated.
|
ArrayList<DefaultQueryExtender> |
getQueryExtenders() |
String |
getResourceInfo(RID documentRid) |
RID |
getRID()
Gets the resource ID of the resource representation of this index.
|
AbstractIndex.RunningState |
getRunningState()
Returns a state indicating what is actually happening with respect to indexing.
|
ISchedulerTimeTable |
getSchedulerTimeTable()
Returns the timetable of a schedule for delta index crawling for the index.
|
DefaultIMSecurityManager |
getSecManager()
Only for internal usage
|
IRidList |
getServiceErrorRids(int maxNumber)
Returns the errors of the search or classification service for this index.
|
String |
getServiceId()
Specifies the index implementation that is used for the index.
|
List |
getServiceTypes(Locale locale)
Displays representations of the indexes service types in the locale's language.
|
List |
getSimilarClasses(IPropertyName propName,
String value,
int maxResults) |
ISupportedOptionSet |
getSupportedOptions()
The actions of the additional interfaces of an index are supported actions for the index in question
(for example,
ISearchIndex, IClassificationIndex )
that are supported by the index implementation. |
static ISystemList |
getSystemList() |
AbstractIndex.WhatToIndex |
getWhatToIndex() |
String |
getWhatToIndexString()
String version of what is indexed (collection, simple resource, both)
|
boolean |
indexContentOfExternalLinks()
Checks if the content of external links should be indexed.
|
void |
indexDocument(IResource resource)
Indexes a document
|
void |
indexDocument(IResource resource,
IResourceEvent resourceEvent)
Indexes a document
|
void |
indexDocuments(IResourceList resources)
Indexes a list of documents
|
void |
indexDocuments(IResourceList resources,
IResourceEvent resourceEvent)
Indexes a list of documents
|
boolean |
indexExistsAndReadyForDeleteOrClear()
Helper method making some checks if index is ready for the next operations.
|
boolean |
indexInternalLinks()
Checks if internal links should be indexed.
|
static boolean |
indexStringAttributeAsString(IMetaName metaName) |
void |
init(Properties properties)
Initialises the index with index implementation specific data
|
protected void |
internalDeindexDocuments(IRidList rids)
Deindexes documents
|
protected void |
internalIndexDocuments(IResourceList resources,
IResourceEvent resourceEvent)
Indexes a list of documents
|
void |
internalSetIndexFolders(IIndexFolderList indexFolders)
For internal use only!
|
boolean |
isActive()
Returns the information if an index is available or has be set inactive.
|
static boolean |
isInSystemFolder(RID currRid) |
static boolean |
isLogicalVariant(IResource res)
Checks if a resource is a logical variant.
|
static boolean |
isPhysicalVariant(IResource res)
Checks if a resource is a physical.
|
boolean |
onlyVirtualDatasources() |
int |
reduceNumberOfCrawler()
Only for internal usage.
|
void |
reindex()
Reindexes the index
|
void |
reindex(boolean disablePostClearTasks)
Reindexes the index
|
void |
reindexNotTrainingDocs() |
void |
reindexWithoutClear()
Reindexing without clearing the index first.
|
protected boolean |
reindexXPostClear(IIndexFolderList preClearIndexFolders) |
void |
removeAllFolderUris()
Deprecated.
as of NW04. Use clear() at the IIndexFolderList interface
|
void |
removeFolderUri(URI folderUri)
Deprecated.
as of NW04. Use remove(IIndexFolder) at the IIndexFolderList interface
|
void |
repaireConfigurable()
Only for internal usage.
|
void |
restartAll()
Stops all stopped and suspended tasks for indexing.
|
void |
resumeAll()
Resumes all suspended tasks for indexing.
|
boolean |
setActive(boolean isActive)
Sets an index inactive or activates it.
|
void |
setActiveDuringStartup(boolean isActive)
Only for internal usage
|
void |
setClassProperties(HashSet set) |
void |
setCrawlerProfileId(String crawlerProfileId)
Sets the ID of the default crawler profile for all index folders of the index.
|
void |
setInactiveIndexHasChanged()
Sets a property on true, if index documents have changed during index
was inactive.
|
void |
setIndexGroup(String indexGroup)
for internal use
|
void |
setIndexingState(AbstractIndex.IndexingState state)
Only for internal usage
|
void |
setIndexName(String indexName)
For internal use only.
|
void |
setNumberOfCrawler(int numOfCrawler) |
void |
setProperties(Properties properties)
Sets index implementation specific data
|
void |
setQueryExtender(DefaultQueryExtender extender)
Only for internal usage.
|
void |
setSchedulerTimeTable(ISchedulerTimeTable schedulerTimeTablePar)
Registers a schedule for delta index crawling for the index with the
ISchedulerTimeTable . |
void |
setStateAndNumberOfCrawler(AbstractIndex.IndexingState state,
int numOfCrawler)
Only for internal usage.
|
void |
setWhatToIndex(String s)
Set what should be indexed (collections, simple resources or both)
|
void |
startReindexer(boolean disablePostClearTasks)
Starts reindexing in a separate thread.
|
void |
startReindexerWithoutClear()
Starts reindexing without clearing the index in a separate thread.
|
void |
stopAll()
Stops all running tasks for indexing.
|
void |
suspendAll()
Suspends all running tasks for indexing.
|
boolean |
typeShouldBeIndexed(IResource res)
Checks if the type (collection, simple resource) should be indexed.
|
static String |
unescape(String s) |
static String |
unescape(String s,
char par) |
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
clear, delete, delete, generate, generate, getResourceInfo, getServiceTypes
public static final String CFG_PLUGIN_CM_INDEXES
public static final String CFG_PLUGIN_CM_INDEXES_INDEX_FOLDERS
public static final String PROPERTIES
public static final String INDEX_STRING_AS_STRING
public static final String INDEX_ALSO_AS_STRING
public static final String AS_STRING
protected String m_indexId
protected IIndexFolderList m_indexFolders
protected String m_serviceId
protected String m_indexName
protected String m_indexGroup
protected boolean m_isActive
protected String m_crawlerProfileId
protected static String m_serviceUserId
public AbstractIndex(String indexId, String indexName, String indexGroup, IIndexFolderList indexFolders, String serviceId, String serviceUserId, Properties indexServiceProperties) throws WcmException
indexId
- - index identifierindexName
- - display name of the indexindexGroup
- - the group the index has been assigned toserviceId
- - the identifier of the index serviceserviceUserId
- - id of the index management service user, to set the service contextindexServiceProperties
- - config properties of the index management serviceindexFolders
- - indexFoldersWcmException
- Exception raised in failure situationpublic AbstractIndex(String indexId, String indexName, String indexGroup, IIndexFolderList indexFolders, String serviceId, String crawlerProfileId, String serviceUserId, Properties indexServiceProperties) throws WcmException
indexId
- - index identifierindexName
- - display name of the indexindexGroup
- - the group the index has been assigned toserviceId
- - the identifier of the index servicecrawlerProfileId
- - ID of the default crawler profile for all index folders of the indexserviceUserId
- - id of the index management service user, to set the service contextindexServiceProperties
- - config properties of the index management serviceindexFolders
- - indexFoldersWcmException
- Exception raised in failure situationpublic static StringBuffer escape(String s)
public static StringBuffer escape(String s, char par)
public static Date convertDateToIndexTime(Date dateInput)
dateInput
- date to be convertedpublic static byte getModeledPropertyIndexType(IPropertyName propName) throws WcmException
propName
- Property nameWcmException
- WcmException - when exception occuredpublic static byte getModeledPropertyIndexType(IMetaName metaName) throws WcmException
metaName
- meta property nameIQueryEntry
.WcmException
- WcmException - when exception occuredpublic IPropertyMap getIndexedProperties() throws WcmException
getIndexedProperties
in interface IIndex
WcmException
- Exception raised in failure situationpublic void getIndexedProperties(List indexList, IMutablePropertyMap returnMap) throws WcmException
indexList
- the index listreturnMap
- map of propertiesWcmException
- WcmExceptionpublic void setIndexName(String indexName)
setIndexName
in interface IIndex
indexName
- The new IndexName valuepublic void setIndexGroup(String indexGroup)
setIndexGroup
in interface IIndex
indexGroup
- The new IndexGroup valuepublic void setCrawlerProfileId(String crawlerProfileId) throws WcmException
setCrawlerProfileId
in interface IIndex
crawlerProfileId
- The new CrawlerProfileId valueWcmException
- WcmException
if the operation failspublic void setProperties(Properties properties)
setProperties
in interface IIndex
properties
- The new Properties valuepublic void clearPropertiesCache()
public String getIndexId()
IIndex
IIndex
object
from the IIndexService
.getIndexId
in interface IIndex
public String getIndexName()
IIndex
getIndexName
in interface IIndex
public IUriList getFolderUris()
getFolderUris
in interface IIndex
public IIndexFolderList getIndexFolders()
IIndex
IIndexFolderList
. If more than one superior folder
is attached to different indexes, the lower folder determines the index, in which
the document is stored.getIndexFolders
in interface IIndex
public String getServiceId()
IIndex
com.sapportals.wcm.service.indexmanagement.retrieval.trex.TrexSearchAndClassificationIndex
ISearchIndex
, IClassificationIndex
getServiceId
in interface IIndex
It is configured in the wcm configuration file and links to the implementing class.
public String getIndexGroup()
IIndex
group
can be null
.getIndexGroup
in interface IIndex
As an example indexes can be grouped to display them separated in groups.
public String getCrawlerProfileId()
getCrawlerProfileId
in interface IIndex
public List getServiceTypes(Locale locale)
IIndex
getServiceTypes
in interface IIndex
locale
- - locale of user context to return service types in locale language of user contextpublic Map getPropertiesAsStrings() throws NotSupportedException
NotSupportedException
- NotSupportedExceptionpublic Properties convertStringPropertiesToObjects(List stringProperties) throws NotSupportedException
stringProperties
- the propertiesNotSupportedException
- NotSupportedExceptionpublic Properties getProperties()
getProperties
in interface IIndex
public void checkProperties(Properties customProperties) throws WcmException
checkProperties
in interface IIndex
customProperties
- customPropertiesWcmException
- WcmExceptionIIndex
public ISupportedOptionSet getSupportedOptions()
IIndex
ISearchIndex, IClassificationIndex
)
that are supported by the index implementation.
Example:
String indexId = "abc"; IIndexService indexService = (IIndexService)ResourceFactory.getInstance().getServiceFactory().getService(IServiceTypesConst.INDEX_SERVICE); IIndex index = indexService.getIndex(indexId); ISupportedOptionSet supportedOptions = index.getSupportedOptions(); if (supportedOptions.isSupported(SupportedOption.SEARCH)) { //do search; it is supported by the index }
getSupportedOptions
in interface IIndex
public List getLanguagesOfIndexedDocuments() throws WcmException
getLanguagesOfIndexedDocuments
in interface IIndex
WcmException
- WcmExceptionpublic Set getLanguagesOfIndexedDocuments(List indexes) throws WcmException
indexes
- the list of indexesWcmException
- WcmExceptionpublic void addFolderUri(URI folderUri)
addFolderUri
in interface IIndex
folderUri
- FolderUri to be addedpublic void removeAllFolderUris()
removeAllFolderUris
in interface IIndex
public void removeFolderUri(URI folderUri)
removeFolderUri
in interface IIndex
folderUri
- uri of folder to remove from indexpublic void indexDocuments(IResourceList resources, IResourceEvent resourceEvent) throws ResourceException, WcmException, IOException
indexDocuments
in interface IIndex
resources
- resources to indexresourceEvent
- event that caused the index requestResourceException
- Exception raised in failure situationWcmException
- Exception raised in failure situationIOException
- Exception raised in failure situationpublic void indexDocuments(IResourceList resources) throws ResourceException, WcmException, IOException
indexDocuments
in interface IIndex
resources
- resources to indexResourceException
- Exception raised in failure situationWcmException
- Exception raised in failure situationIOException
- Exception raised in failure situationpublic void indexDocument(IResource resource) throws ResourceException, WcmException, IOException
indexDocument
in interface IIndex
resource
- resource to indexResourceException
- Exception raised in failure situationWcmException
- Exception raised in failure situationIOException
- Exception raised in failure situationpublic void indexDocument(IResource resource, IResourceEvent resourceEvent) throws ResourceException, WcmException, IOException
indexDocument
in interface IIndex
resource
- resource to indexresourceEvent
- event that caused the index requestResourceException
- Exception raised in failure situationWcmException
- Exception raised in failure situationIOException
- Exception raised in failure situationpublic void deindexDocuments(IResourceList resources) throws ResourceException, WcmException
deindexDocuments
in interface IIndex
resources
- resources to deindexResourceException
- Exception raised in failure situationWcmException
- Exception raised in failure situationpublic void deindexDocuments(IUriList resourceUris) throws ResourceException, WcmException
deindexDocuments
in interface IIndex
resourceUris
- list of uris to deindexResourceException
- Exception raised in failure situationWcmException
- Exception raised in failure situationpublic void deindexDocuments(IRidList resourceRids) throws ResourceException, WcmException
deindexDocuments
in interface IIndex
resourceRids
- list of rids to deindexResourceException
- Exception raised in failure situationWcmException
- Exception raised in failure situationpublic void deindexDocument(IResource resource) throws ResourceException, WcmException
deindexDocument
in interface IIndex
resource
- resource to deindexResourceException
- Exception raised in failure situationWcmException
- Exception raised in failure situationpublic void deindexDocument(URI resourceUri) throws ResourceException, WcmException
deindexDocument
in interface IIndex
resourceUri
- uri to deindexResourceException
- Exception raised in failure situationWcmException
- Exception raised in failure situationpublic void deindexDocument(RID resourceRid) throws ResourceException, WcmException
deindexDocument
in interface IIndex
resourceRid
- rid to deindexResourceException
- Exception raised in failure situationWcmException
- Exception raised in failure situationpublic void reindex() throws WcmException
reindex
in interface IIndex
WcmException
- Exception raised in failure situationpublic void reindexWithoutClear() throws WcmException
WcmException
- Exception raised in failure situationpublic boolean indexExistsAndReadyForDeleteOrClear() throws WcmException
WcmException
- WcmExceptionpublic void reindex(boolean disablePostClearTasks) throws WcmException
reindex
in interface IIndex
disablePostClearTasks
- - if true the tasks that can be performed by the index implementation after the index
has been cleared are skipped. Example: Don't train the classification index before reindex all documents.WcmException
- Exception raised in failure situationpublic void deleteOnServer() throws WcmException
IIndex
deleteOnServer
in interface IIndex
WcmException
- WcmExceptionpublic static void deleteOnServer(String indexId) throws WcmException
WcmException
public void createIndexOnServer() throws WcmException
IIndex
createIndexOnServer
in interface IIndex
WcmException
- WcmExceptionpublic void startReindexer(boolean disablePostClearTasks) throws WcmException
disablePostClearTasks
- flag to disable the clear tasksWcmException
- WcmExceptionpublic void startReindexerWithoutClear() throws WcmException
WcmException
- WcmExceptionpublic void deltaReindex() throws WcmException
deltaReindex
in interface IIndex
WcmException
- exception raised in failure situationpublic void init(Properties properties)
protected void internalIndexDocuments(IResourceList resources, IResourceEvent resourceEvent) throws ResourceException, WcmException, IOException
resources
- resources to indexresourceEvent
- event that caused the index requestResourceException
- Exception raised in failure situationWcmException
- Exception raised in failure situationIOException
- Exception raised in failure situationprotected void internalDeindexDocuments(IRidList rids) throws ResourceException, WcmException
rids
- list of rids to deindexResourceException
- Exception raised in failure situationWcmException
- Exception raised in failure situationprotected boolean reindexXPostClear(IIndexFolderList preClearIndexFolders) throws WcmException
WcmException
public IIndexFolder getIndexFolderForDocument(RID documentRid)
getIndexFolderForDocument
in interface IIndex
documentRid
- rid of the document to get the index folder forpublic void reindexNotTrainingDocs() throws WcmException
WcmException
public int compareTo(Object o)
o
- object to comparepublic void internalSetIndexFolders(IIndexFolderList indexFolders)
indexFolders
- the index folderspublic String getResourceInfo(RID documentRid) throws WcmException
documentRid
- the document RIDWcmException
- WcmExceptionIIndex
public static ISystemList getSystemList() throws WcmException
WcmException
- WcmExceptionpublic void setSchedulerTimeTable(ISchedulerTimeTable schedulerTimeTablePar) throws WcmException
ISchedulerTimeTable
. Thereby it sets this schedule for all
data sources with no own schedule.
Remark: It is recommended to use the similar method of the
IIndexService
instead of this method.setSchedulerTimeTable
in interface IIndex
schedulerTimeTablePar
- ISchedulerTimeTable
WcmException
- in case of an error.public ISchedulerTimeTable getSchedulerTimeTable() throws WcmException
IIndexService
instead of this method.getSchedulerTimeTable
in interface IIndex
ISchedulerTimeTable
WcmException
- in case of an error.public boolean isActive()
public boolean setActive(boolean isActive) throws WcmException
setActive
in interface IIndex
isActive
- if index should be set to active,
false if index should be deactivatedWcmException
- in case of an error.public void setActiveDuringStartup(boolean isActive) throws WcmException
IIndex
setActiveDuringStartup
in interface IIndex
isActive
- isActiveWcmException
- WcmExceptionpublic void setInactiveIndexHasChanged() throws WcmException, ResourceException
setInactiveIndexHasChanged
in interface IIndex
WcmException
- in case of an errorResourceException
- in case of an errorpublic RID getRID() throws WcmException
getRID
in interface IIndex
WcmException
- in case of an error.public void checkIndexIsActive() throws WcmException
WcmException
- WcmExceptionpublic void setStateAndNumberOfCrawler(AbstractIndex.IndexingState state, int numOfCrawler) throws WcmException
setStateAndNumberOfCrawler
in interface IIndex
state
- the statenumOfCrawler
- number of crawlersWcmException
- WcmExceptionpublic void setNumberOfCrawler(int numOfCrawler) throws ResourceException, WcmException
numOfCrawler
- number of crawlersResourceException
- ResourceExceptionWcmException
- WcmExceptionpublic void setIndexingState(AbstractIndex.IndexingState state) throws ResourceException, WcmException
IIndex
setIndexingState
in interface IIndex
state
- stateWcmException
- WcmExceptionResourceException
public void repaireConfigurable() throws Exception
Exception
- Exceptionpublic int getNumberOfCrawler(RID indexRid) throws WcmException
indexRid
- indexRidWcmException
- WcmExceptionpublic int reduceNumberOfCrawler() throws WcmException
reduceNumberOfCrawler
in interface IIndex
WcmException
- WcmExceptionpublic AbstractIndex.IndexingState getIndexingState() throws ResourceException, WcmException
getIndexingState
in interface IIndex
WcmException
- WcmExceptionResourceException
public String getDetailsMonitorURL1() throws NotSupportedException
NotSupportedException
- if the method is not implemented for an indexpublic String getDetailsMonitorURL2() throws NotSupportedException
NotSupportedException
- if the method is not implemented for an indexpublic String getDetailsMonitorURL3() throws NotSupportedException
NotSupportedException
- if the method is not implemented for an indexpublic String getDetailsMonitorPageURL() throws NotSupportedException
NotSupportedException
- if the method is not implemented for an indexpublic String getDetailsMonitorPageText(Locale locale) throws NotSupportedException
locale
- the localeNotSupportedException
- if the method is not implemented for an indexpublic String[] getFrameSizes() throws NotSupportedException
NotSupportedException
- if the method is not implemented for an indexpublic AbstractIndex.ErrorState getErrorState(double errorThreshold, double warningThreshold, Locale locale) throws NotSupportedException
errorThreshold
- the error thresholdwarningThreshold
- the warning thresholdlocale
- the localeNotSupportedException
- if the method is not implemented for an indexpublic AbstractIndex.RunningState getRunningState() throws WcmException
NotSupportedException
- if the method is not implemented for an indexWcmException
- WcmExceptionpublic int getNumberOfSuccessfullyIndexedDocs() throws WcmException
NotSupportedException
- if the method is not implemented for an indexWcmException
- WcmExceptionpublic int getNumberOfDocumentsInQueue() throws WcmException
NotSupportedException
- if the method is not implemented for an indexWcmException
- WcmExceptionpublic int getNumberOfErrors() throws WcmException
NotSupportedException
- if the method is not implemented for an indexWcmException
- WcmExceptionpublic int getNumberOfIndexErrors(RID startRid) throws WcmException
startRid
- the start ridWcmException
- WcmExceptionpublic IRidList getServiceErrorRids(int maxNumber) throws WcmException
maxNumber
- the maximum number of errorsWcmException
- WcmExceptionpublic long getActiveTime() throws WcmException
NotSupportedException
- if the method is not implemented for an indexWcmException
- WcmExceptionpublic AbstractIndex.WhatToIndex getWhatToIndex()
public void setWhatToIndex(String s)
IIndex
setWhatToIndex
in interface IIndex
s
- what should be indexedpublic String getWhatToIndexString()
IIndex
getWhatToIndexString
in interface IIndex
public static boolean isLogicalVariant(IResource res)
res
- resourcepublic static boolean isPhysicalVariant(IResource res)
res
- resourcepublic boolean typeShouldBeIndexed(IResource res)
IIndex
typeShouldBeIndexed
in interface IIndex
res
- resourcepublic static PropertyName getDisplayNameAsStringPropName() throws ResourceException
ResourceException
- ResourceExceptionpublic static PropertyName getIndexFolderRidPropName() throws ResourceException
ResourceException
- ResourceExceptionpublic static PropertyName getDocumentFeaturesPropName() throws ResourceException
ResourceException
public static PropertyName getLogicalOrPhysicalPropName() throws ResourceException
ResourceException
public static PropertyName getIndexOnlyPropertiesPropName() throws ResourceException
ResourceException
public void suspendAll() throws WcmException
NotSupportedException
- if the method is not implemented for an indexWcmException
- WcmExceptionpublic void resumeAll() throws WcmException
NotSupportedException
- if the method is not implemented for an indexWcmException
- WcmExceptionpublic void stopAll() throws WcmException
NotSupportedException
- if the method is not implemented for an indexWcmException
- WcmExceptionpublic void restartAll() throws WcmException
NotSupportedException
- if the method is not implemented for an indexWcmException
- WcmExceptionpublic static boolean indexStringAttributeAsString(IMetaName metaName)
metaName
- the meta namepublic boolean indexInternalLinks()
IIndex
indexInternalLinks
in interface IIndex
public boolean flush(RID rid, int counter) throws WcmException
rid
- ridcounter
- counterWcmException
- WcmExceptionpublic void flushAsync(RID rid, int counter) throws WcmException
rid
- ridcounter
- counterWcmException
- WcmExceptionpublic void flush() throws WcmException
WcmException
- WcmExceptionpublic void flushAsync() throws WcmException
WcmException
- WcmExceptionpublic static boolean isInSystemFolder(RID currRid)
currRid
- the ridpublic static Map getHiddenIndexIds() throws ResourceException
ResourceException
- ResourceExceptionpublic boolean indexContentOfExternalLinks()
public IPropertyMap getPropertiesForHiddenResource(RID rid) throws WcmException
rid
- the ridWcmException
- WcmExceptionpublic IContent getContent(RID rid) throws WcmException
rid
- the ridWcmException
- WcmExceptionpublic Collection getOriginalContent(IRidList ridList) throws WcmException
ridList
- the list of ridsWcmException
- WcmExceptionpublic int getNumberOfIndexedDocuments(IIndexFolder indexFolder, IResourceContext context) throws NotSupportedException
indexFolder
- the infex foldercontext
- contextNotSupportedException
- if the method is not implemented by the index type.public RID getHiddenIndexAreaStartRid()
public DefaultIMSecurityManager getSecManager() throws ResourceException
ResourceException
- ResourceException@Deprecated public DefaultQueryExtender getQueryExtender() throws ResourceException
ResourceException
- ResourceExceptionpublic ArrayList<DefaultQueryExtender> getQueryExtenders() throws ResourceException
ResourceException
public void setQueryExtender(DefaultQueryExtender extender)
extender
- the query extenderpublic Collection getHighlightedContent(ISearchResultList searchResults, IQueryEntryList queryList) throws WcmException
searchResults
- search result list with resources for which content have to be returnedqueryList
- the queries to be highlightedWcmException
- WcmExceptionpublic Collection getHighlightedContent(ISearchResultList searchResults, IQueryEntryList queryList, boolean anchorlinks) throws WcmException
searchResults
- search result list with resources for which content have to be returnedqueryList
- the queries to be highlightedanchorlinks
- if true anchorlinks to the highlighted term are presentedWcmException
- WcmExceptionpublic boolean onlyVirtualDatasources()
public HashSet getClassProperties() throws ResourceException
ResourceException
public void setClassProperties(HashSet set)
public List getSimilarClasses(IPropertyName propName, String value, int maxResults) throws WcmException
getSimilarClasses
in interface IIndex
propName
- property namevalue
- the valuemaxResults
- the maximum number of resultsWcmException
- WcmExceptionpublic void changeIndexedDocumentProperties(RID rid, IPropertyMap addProperties, IPropertyMap deleteProperties, IPropertyNameList deleteValues, IProperty testProperty) throws WcmException
IIndex
changeIndexedDocumentProperties
in interface IIndex
rid
- ridaddProperties
- addPropertiesdeleteProperties
- deletePropertiesdeleteValues
- deleteValuestestProperty
- testPropertyWcmException
- WcmExceptionpublic void changeIndexedDocumentProperties(RID rid, IPropertyMap addProperties, IPropertyMap deleteProperties, IPropertyNameList deleteValues, boolean testQueue) throws WcmException
IIndex
changeIndexedDocumentProperties
in interface IIndex
rid
- ridaddProperties
- addPropertiesdeleteProperties
- deletePropertiesdeleteValues
- deleteValuestestQueue
- testQueueWcmException
- WcmExceptionpublic List changeIndexedDocumentProperties(RID rid, IPropertyMap addProperties, IPropertyMap deleteProperties, IPropertyMap defineProperties) throws NotSupportedException
IIndex
changeIndexedDocumentProperties
in interface IIndex
rid
- RID of the resourceaddProperties
- Properties which should added to the resourcedeleteProperties
- Properties which should deleted from the resourcedefineProperties
- Properties for which the definition has to be send to the server first, because until now no
indexed document already contains itNotSupportedException
- NotSupportedExceptionpublic void deindex(IQueryEntryList query) throws WcmException
IIndex
deindex
in interface IIndex
query
- the queryWcmException
- when deindex cannot be executedAccess Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] KMC-CM
|
[sap.com] tc/km/frwk
|
api
|
EP-KM-CM
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2018 SAP AG Complete Copyright Notice