com.sapportals.wcm.service.indexmanagement

Class AbstractIndex

java.lang.Object
  com.sapportals.wcm.service.indexmanagement.AbstractIndex

All Implemented Interfaces:

IIndex

Direct Known Subclasses:

AbstractClassificationIndex

public abstract class AbstractIndex
extends Object
implements IIndex

Generic index class, which must be extended by a specialized index implementation.
Changes between major releases 7.0 and 7.X

• Added inner classes: AbstractIndex.ReindexerWithoutClear
• Added methods: 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)
• Deleted methods: getConfigServiceUser, internalAddQueuedCrawler, internalRunQueuedIfNoActive, reindexPostClear

See Also:

IIndex

Nested Class Summary

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

Field Summary

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 Summary

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.

Method Summary

void	addFolderUri(com.sapportals.wcm.util.uri.URI folderUri) Deprecated. as of NW04. Use add(IIndexFolder) at the IIndexFolderList interface
List	changeIndexedDocumentProperties(com.sapportals.wcm.util.uri.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(com.sapportals.wcm.util.uri.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(com.sapportals.wcm.util.uri.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 plugin 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 attributeand returns this value.
Properties	convertStringPropertiesToObjects(List stringProperties) Gets as import the additional properties for the index as a String list in the form propName1, value1, probName2, value2 etc.
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(com.sapportals.wcm.util.uri.RID resourceRid) Deindexes a document
void	deindexDocument(com.sapportals.wcm.util.uri.URI resourceUri) Deprecated. as of NW04. Use deindexDocument(RID)
void	deindexDocuments(IResourceList resources) Deindexes a document
void	deindexDocuments(com.sapportals.wcm.util.uri.IRidList resourceRids) Deindexes a document
void	deindexDocuments(com.sapportals.wcm.util.uri.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(com.sapportals.wcm.util.uri.RID rid, int counter) Tries about counter of times to bring the documents decribed by the rid in a state such that the document can be found in the index.
void	flushAsync() Asynchronous flush.
void	flushAsync(com.sapportals.wcm.util.uri.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(com.sapportals.wcm.util.uri.RID rid) Returns the content for the specified ridList.
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() Get details monitor portal page
String	getDetailsMonitorURL1() Get first details monitor
String	getDetailsMonitorURL2() Get second details monitor
String	getDetailsMonitorURL3() Get third details monitor
static PropertyName	getDisplayNameAsStringPropName()
static PropertyName	getDocumentFeaturesPropName()
AbstractIndex.ErrorState	getErrorState(double errorThreshold, double warningThreshold, Locale locale) Returns an error state indicating the overall indexing status.
com.sapportals.wcm.util.uri.IUriList	getFolderUris() Deprecated. as of NW04. Use getFolderRids()
String[]	getFrameSizes() Get frame sizes of detailed monitors (and implicit number of detailed monitors)
com.sapportals.wcm.util.uri.RID	getHiddenIndexAreaStartRid() Returns the start rid of an hidden index
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(com.sapportals.wcm.util.uri.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) Returns the property type for a modelled property which is used for indexing.
static byte	getModeledPropertyIndexType(IPropertyName propName) Returns the type of a modelled property how it is indexed (usually on a Trex server).
int	getNumberOfCrawler(com.sapportals.wcm.util.uri.RID indexRid) Only for internal usage.
int	getNumberOfDocumentsInQueue() Returns the numbers of documents currently in work for indexing, but not in an error state.
int	getNumberOfErrors() Returns the numbers of documents failed during indexing.
int	getNumberOfIndexedDocuments(IIndexFolder indexFolder, IResourceContext context) Returns the number of documents of the datasource of the index which are already in the index
int	getNumberOfIndexErrors(com.sapportals.wcm.util.uri.RID startRid) Returns the number of crawler errors for the specified data source.
int	getNumberOfSuccessfullyIndexedDocs() Returns the numbers of documents successfully indexed and searchable.
Collection	getOriginalContent(com.sapportals.wcm.util.uri.IRidList ridList) Returns the content for the specified ridList.
Properties	getProperties() Gets index implementation specific data
Map	getPropertiesAsStrings() Returns the properties in a Map of Strings, i.e. the keys describing the property names are Strings as well as the values.
IPropertyMap	getPropertiesForHiddenResource(com.sapportals.wcm.util.uri.RID rid) Returns the properties for the resource specified by the rid.
DefaultQueryExtender	getQueryExtender() Only for internal usage
String	getResourceInfo(com.sapportals.wcm.util.uri.RID documentRid)
com.sapportals.wcm.util.uri.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
com.sapportals.wcm.util.uri.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) The method returns similar property values to the input value with respect to specified property.
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() Checks and returns the system ID where the Indexmanagement Taskqueue Reader task should run.
AbstractIndex.WhatToIndex	getWhatToIndex() Returns is the index indexed collextions, simple resources of both.
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) Returns true if the attribute is indexed as a string and false if indexed as text.
void	init(Properties properties) Initializes the index with index implementation specific data
protected void	internalDeindexDocuments(com.sapportals.wcm.util.uri.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(com.sapportals.wcm.util.uri.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 physicalt.
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(com.sapportals.wcm.util.uri.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 seperate thread.
void	startReindexerWithoutClear() Starts reindexing without clearing the index in a seperate 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) shoulb be indexed.
static String	unescape(String s)
static String	unescape(String s, char par)

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.sapportals.wcm.service.indexmanagement.IIndex

clear, delete, delete, generate, generate, getResourceInfo, getServiceTypes

Field Detail

CFG_PLUGIN_CM_INDEXES

public static final String CFG_PLUGIN_CM_INDEXES

See Also:

Constant Field Values

CFG_PLUGIN_CM_INDEXES_INDEX_FOLDERS

public static final String CFG_PLUGIN_CM_INDEXES_INDEX_FOLDERS

See Also:

Constant Field Values

PROPERTIES

public static final String PROPERTIES

See Also:

Constant Field Values

INDEX_STRING_AS_STRING

public static final String INDEX_STRING_AS_STRING

See Also:

Constant Field Values

INDEX_ALSO_AS_STRING

public static final String INDEX_ALSO_AS_STRING

See Also:

Constant Field Values

AS_STRING

public static final String AS_STRING

See Also:

Constant Field Values

m_indexId

protected String m_indexId

id of the index

m_indexFolders

protected IIndexFolderList m_indexFolders

list of index folders that are assigned to the index

m_serviceId

protected String m_serviceId

the id of the implementing index service

m_indexName

protected String m_indexName

display name of the index

m_indexGroup

protected String m_indexGroup

group of the index

m_isActive

protected boolean m_isActive

Indicates if an index is available or has be deactivated.

m_crawlerProfileId

protected String m_crawlerProfileId

ID of the default crawler profile for all index folders of the index.

m_serviceUserId

protected static String m_serviceUserId

ID of the service user.

Constructor Detail

AbstractIndex

public AbstractIndex(String indexId,
                     String indexName,
                     String indexGroup,
                     IIndexFolderList indexFolders,
                     String serviceId,
                     String serviceUserId,
                     Properties indexServiceProperties)
              throws com.sapportals.wcm.WcmException

Deprecated. as of NW04. Use constructor with crawler profile ID

Constructor.

Parameters:

indexId - - index identifier

indexName - - display name of the index

indexGroup - - the group the index has been assigned to

folderRids - - list of RID objects that are representing the attached folders of the index

serviceId - - the identifier of the index service

serviceUserId - - id of the index management service user, to set the service context

indexServiceProperties - - config properties of the index management service

Throws:

com.sapportals.wcm.WcmException - Exception raised in failure situation

AbstractIndex

public AbstractIndex(String indexId,
                     String indexName,
                     String indexGroup,
                     IIndexFolderList indexFolders,
                     String serviceId,
                     String crawlerProfileId,
                     String serviceUserId,
                     Properties indexServiceProperties)
              throws com.sapportals.wcm.WcmException

Constructor.

Parameters:

indexId - - index identifier

indexName - - display name of the index

indexGroup - - the group the index has been assigned to

folderRids - - list of RID objects that are representing the attached folders of the index

serviceId - - the identifier of the index service

crawlerProfileId - - ID of the default crawler profile for all index folders of the index

serviceUserId - - id of the index management service user, to set the service context

indexServiceProperties - - config properties of the index management service

Throws:

com.sapportals.wcm.WcmException - Exception raised in failure situation

Method Detail

escape

public static StringBuffer escape(String s)

unescape

public static String unescape(String s)

escape

public static StringBuffer escape(String s,
                                  char par)

unescape

public static String unescape(String s,
                              char par)

convertDateToIndexTime

public static Date convertDateToIndexTime(Date dateInput)

Converts the input date into a date used for indexing time attributeand returns this value. The year, month and day is set to 2000-Jan-01.

Parameters:

dateInput -

Returns:

getModeledPropertyIndexType

public static byte getModeledPropertyIndexType(IPropertyName propName)
                                        throws com.sapportals.wcm.WcmException

Returns the type of a modelled property how it is indexed (usually on a Trex server). The possible types are specified in IQueryEntry e.g. IQueryEntry.PROPERTY_TYPE_STRING.

Parameters:

propName -

Returns:

Throws:

com.sapportals.wcm.WcmException

getModeledPropertyIndexType

public static byte getModeledPropertyIndexType(IMetaName metaName)
                                        throws com.sapportals.wcm.WcmException

Returns the property type for a modelled property which is used for indexing. The porperty types are defined in IQueryEntry.

Parameters:

metaName -

Returns:

Throws:

com.sapportals.wcm.WcmException

getIndexedProperties

public IPropertyMap getIndexedProperties()
                                  throws com.sapportals.wcm.WcmException

Returns the properties, indexed with the documents in the index. Only the information about the properties not all their values are returned, i.e. each property appearch only one time in the return map.

Specified by:

getIndexedProperties in interface IIndex

Returns:

Map with the properties

Throws:

com.sapportals.wcm.WcmException - Exception raised in failure situation

getIndexedProperties

public void getIndexedProperties(List indexList,
                                 IMutablePropertyMap returnMap)
                          throws com.sapportals.wcm.WcmException

Adds the properties in the indexes to the property map. The indexes have to be of the same service as the object itself.

Parameters:

indexList -

returnMap -

Throws:

com.sapportals.wcm.WcmException

setIndexName

public void setIndexName(String indexName)

For internal use only. Sets the name of the index.

Specified by:

setIndexName in interface IIndex

Parameters:

indexName - The new IndexName value

setIndexGroup

public void setIndexGroup(String indexGroup)

for internal use

Specified by:

setIndexGroup in interface IIndex

Parameters:

indexGroup - The new IndexGroup value

setCrawlerProfileId

public void setCrawlerProfileId(String crawlerProfileId)
                         throws com.sapportals.wcm.WcmException

Sets the ID of the default crawler profile for all index folders of the index.

Specified by:

setCrawlerProfileId in interface IIndex

Parameters:

CrawlerProfileId - The new CrawlerProfileId value

Throws:

com.sapportals.wcm.WcmException

setProperties

public void setProperties(Properties properties)

Sets index implementation specific data

Specified by:

setProperties in interface IIndex

Parameters:

properties - The new Properties value

clearPropertiesCache

public void clearPropertiesCache()

This method informs a search plugin to clear its custom properties cache

getIndexId

public String getIndexId()

Description copied from interface: IIndex

Identifies the index within the system.
The ID of an index is needed to get the IIndex object from the IIndexService.
Forbidden characters for an index ID are dot('.'), space(' ') and plus('+').

Specified by:

getIndexId in interface IIndex

Returns:

index identifier

getIndexName

public String getIndexName()

Description copied from interface: IIndex

Non-technical identifier of an index.
The index name should be used for display purposes only.
All characters are allowed for an index name. If no index name is available, the index ID is returned.

Specified by:

getIndexName in interface IIndex

Returns:

display name of the index

getFolderUris

public com.sapportals.wcm.util.uri.IUriList getFolderUris()

Deprecated. as of NW04. Use getFolderRids()

Specified by:

getFolderUris in interface IIndex

Returns:

list of URI objects that are representing the attached folders of the index

getIndexFolders

public IIndexFolderList getIndexFolders()

Description copied from interface: IIndex

Folders or start pages that are assigned to the index for indexing.
A document is added to a particular index, if a superior folder (or startpage) is contained in IIndexFolderList. If more than one superior folder is attached to different indexes, the lower folder determines the index, in which the document is stored.

Specified by:

getIndexFolders in interface IIndex

Returns:

list of IIndexFolder objects that are representing the attached folders of the index

getServiceId

public String getServiceId()

Description copied from interface: IIndex

Specifies the index implementation that is used for the index.
Every service ID is linked to a java class from which the index object is instantiated.
The index implementation determines the interfaces that can be used for the index.
Additionally, the service types of the index are determined by the implementation.
Example:
Service ID: trexSearchAndClassification
Java Class: com.sapportals.wcm.service.indexmanagement.retrieval.trex.TrexSearchAndClassificationIndex
Additional interfaces: ISearchIndex, IClassificationIndex
Service types: search, classification

Specified by:

getServiceId in interface IIndex

Returns:

the identifier of the index service (e.g. trexSearchAndClassification).

It is configured in the wcm configuration file and links to the impementing class.

getIndexGroup

public String getIndexGroup()

Description copied from interface: IIndex

Returns the group of indexes to which the index logically belongs.
Grouping indexes makes it possible to perform operations on more than one index by selecting an index group and performing the action on all indexes in that group.
These cumulative functions must be implemented on UI level. Currently this is implemented in the CM search dialog box for the selection of indexes. Selection is carried out by selecting an index group to search in all indexes that belong to that group. group can be null.

Specified by:

getIndexGroup in interface IIndex

Returns:

the group the index has been assigned to

As an example indexes can be grouped to display them separated in groups.

getCrawlerProfileId

public String getCrawlerProfileId()

ID of the default crawler profile for all index folders of the index.

Specified by:

getCrawlerProfileId in interface IIndex

Returns:

crawler profile ID

getServiceTypes

public List getServiceTypes(Locale locale)

Description copied from interface: IIndex

Displays representations of the indexes service types in the locale's language.
The returned types should only be used for display purposes.

Specified by:

getServiceTypes in interface IIndex

Parameters:

locale - - locale of user context to return service types in locale language of user context

Returns:

(String)list of service types the index is belonging to. because of the locale the service types are returned in the locales language

getPropertiesAsStrings

public Map getPropertiesAsStrings()
                           throws NotSupportedException

Returns the properties in a Map of Strings, i.e. the keys describing the property names are Strings as well as the values. Needed, if the index should be transported.

Returns:

Throws:

NotSupportedException

convertStringPropertiesToObjects

public Properties convertStringPropertiesToObjects(List stringProperties)
                                            throws NotSupportedException

Gets as import the additional properties for the index as a String list in the form propName1, value1, probName2, value2 etc. Converts them into the format needed for calling the method init. Needed, if the index should be transported.

Parameters:

stringProperties -

Returns:

Throws:

NotSupportedException

getProperties

public Properties getProperties()

Gets index implementation specific data

Specified by:

getProperties in interface IIndex

Returns:

The Properties value

checkProperties

public void checkProperties(Properties customProperties)
                     throws com.sapportals.wcm.WcmException

Executes some consistency checks on the properties.

Specified by:

checkProperties in interface IIndex

Throws:

com.sapportals.wcm.WcmException

See Also:

IIndex

getSupportedOptions

public ISupportedOptionSet getSupportedOptions()

Description copied from interface: IIndex

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.

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
  }
 

Specified by:

getSupportedOptions in interface IIndex

Returns:

a collection of supported operations specified in the class SupportedOption

getLanguagesOfIndexedDocuments

public List getLanguagesOfIndexedDocuments()
                                    throws com.sapportals.wcm.WcmException

Returns the languages of an index, for which documents exist in.

Specified by:

getLanguagesOfIndexedDocuments in interface IIndex

Returns:

List of strings each describing one language.

Throws:

com.sapportals.wcm.WcmException

getLanguagesOfIndexedDocuments

public Set getLanguagesOfIndexedDocuments(List indexes)
                                   throws com.sapportals.wcm.WcmException

Returns the languages of the indexes, for which documents exist in. The indexes have to be of the same service as the object itself.

Parameters:

indexes -

Returns:

language set

Throws:

com.sapportals.wcm.WcmException

addFolderUri

public void addFolderUri(com.sapportals.wcm.util.uri.URI folderUri)

Deprecated. as of NW04. Use add(IIndexFolder) at the IIndexFolderList interface

for internal use

Specified by:

addFolderUri in interface IIndex

Parameters:

folderUri - FolderUri to be added

removeAllFolderUris

public void removeAllFolderUris()

Deprecated. as of NW04. Use clear() at the IIndexFolderList interface

for internal use

Specified by:

removeAllFolderUris in interface IIndex

removeFolderUri

public void removeFolderUri(com.sapportals.wcm.util.uri.URI folderUri)

Deprecated. as of NW04. Use remove(IIndexFolder) at the IIndexFolderList interface

for internal use

Specified by:

removeFolderUri in interface IIndex

Parameters:

folderUri - uri of folder to remove from index

indexDocuments

public void indexDocuments(IResourceList resources,
                           IResourceEvent resourceEvent)
                    throws ResourceException,
                           com.sapportals.wcm.WcmException,
                           IOException

Indexes a list of documents

Specified by:

indexDocuments in interface IIndex

Parameters:

resources - resources to index

resourceEvent - event that caused the index request

Throws:

ResourceException - Exception raised in failure situation

com.sapportals.wcm.WcmException - Exception raised in failure situation

IOException - Exception raised in failure situation

indexDocuments

public void indexDocuments(IResourceList resources)
                    throws ResourceException,
                           com.sapportals.wcm.WcmException,
                           IOException

Indexes a list of documents

Specified by:

indexDocuments in interface IIndex

Parameters:

resources - resources to index

Throws:

ResourceException - Exception raised in failure situation

com.sapportals.wcm.WcmException - Exception raised in failure situation

IOException - Exception raised in failure situation

indexDocument

public void indexDocument(IResource resource)
                   throws ResourceException,
                          com.sapportals.wcm.WcmException,
                          IOException

Indexes a document

Specified by:

indexDocument in interface IIndex

Parameters:

resource - resource to index

Throws:

ResourceException - Exception raised in failure situation

com.sapportals.wcm.WcmException - Exception raised in failure situation

IOException - Exception raised in failure situation

indexDocument

public void indexDocument(IResource resource,
                          IResourceEvent resourceEvent)
                   throws ResourceException,
                          com.sapportals.wcm.WcmException,
                          IOException

Indexes a document

Specified by:

indexDocument in interface IIndex

Parameters:

resource - resource to index

resourceEvent - event that caused the index request

Throws:

ResourceException - Exception raised in failure situation

com.sapportals.wcm.WcmException - Exception raised in failure situation

IOException - Exception raised in failure situation

deindexDocuments

public void deindexDocuments(IResourceList resources)
                      throws ResourceException,
                             com.sapportals.wcm.WcmException

Deindexes a document

Specified by:

deindexDocuments in interface IIndex

Parameters:

resources - resources to deindex

Throws:

ResourceException - Exception raised in failure situation

com.sapportals.wcm.WcmException - Exception raised in failure situation

deindexDocuments

public void deindexDocuments(com.sapportals.wcm.util.uri.IUriList resourceUris)
                      throws ResourceException,
                             com.sapportals.wcm.WcmException

Deprecated. as of NW04. Use deindexDocuments(IRidList)

Deindexes a document

Specified by:

deindexDocuments in interface IIndex

Parameters:

resourceUris - list of uris to deindex

Throws:

ResourceException - Exception raised in failure situation

com.sapportals.wcm.WcmException - Exception raised in failure situation

deindexDocuments

public void deindexDocuments(com.sapportals.wcm.util.uri.IRidList resourceRids)
                      throws ResourceException,
                             com.sapportals.wcm.WcmException

Deindexes a document

Specified by:

deindexDocuments in interface IIndex

Parameters:

resourceRids - list of rids to deindex

Throws:

ResourceException - Exception raised in failure situation

com.sapportals.wcm.WcmException - Exception raised in failure situation

deindexDocument

public void deindexDocument(IResource resource)
                     throws ResourceException,
                            com.sapportals.wcm.WcmException

Deindexes a document

Specified by:

deindexDocument in interface IIndex

Parameters:

resource - resource to deindex

Throws:

ResourceException - Exception raised in failure situation

com.sapportals.wcm.WcmException - Exception raised in failure situation

deindexDocument

public void deindexDocument(com.sapportals.wcm.util.uri.URI resourceUri)
                     throws ResourceException,
                            com.sapportals.wcm.WcmException

Deprecated. as of NW04. Use deindexDocument(RID)

Deindexes a document

Specified by:

deindexDocument in interface IIndex

Parameters:

resourceUri - uri to deindex

Throws:

ResourceException - Exception raised in failure situation

com.sapportals.wcm.WcmException - Exception raised in failure situation

deindexDocument

public void deindexDocument(com.sapportals.wcm.util.uri.RID resourceRid)
                     throws ResourceException,
                            com.sapportals.wcm.WcmException

Deindexes a document

Specified by:

deindexDocument in interface IIndex

Parameters:

resourceRid - rid to deindex

Throws:

ResourceException - Exception raised in failure situation

com.sapportals.wcm.WcmException - Exception raised in failure situation

reindex

public void reindex()
             throws com.sapportals.wcm.WcmException

Reindexes the index

Specified by:

reindex in interface IIndex

Throws:

com.sapportals.wcm.WcmException - Exception raised in failure situation

reindexWithoutClear

public void reindexWithoutClear()
                         throws com.sapportals.wcm.WcmException

Reindexing without clearing the index first.

Throws:

com.sapportals.wcm.WcmException - Exception raised in failure situation

indexExistsAndReadyForDeleteOrClear

public boolean indexExistsAndReadyForDeleteOrClear()
                                            throws com.sapportals.wcm.WcmException

Helper method making some checks if index is ready for the next operations.

Returns:

Throws:

com.sapportals.wcm.WcmException

reindex

public void reindex(boolean disablePostClearTasks)
             throws com.sapportals.wcm.WcmException

Reindexes the index

Specified by:

reindex in interface IIndex

Parameters:

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.

Throws:

com.sapportals.wcm.WcmException - Exception raised in failure situation

deleteOnServer

public void deleteOnServer()
                    throws com.sapportals.wcm.WcmException

Description copied from interface: IIndex

Deletes the index on the index server connected with the CM system.

Specified by:

deleteOnServer in interface IIndex

Throws:

com.sapportals.wcm.WcmException

deleteOnServer

public static void deleteOnServer(String indexId)
                           throws com.sapportals.wcm.WcmException

Throws:

com.sapportals.wcm.WcmException

createIndexOnServer

public void createIndexOnServer()
                         throws com.sapportals.wcm.WcmException

Description copied from interface: IIndex

Creates the index on the index server connected with the CM system.

Specified by:

createIndexOnServer in interface IIndex

Throws:

com.sapportals.wcm.WcmException

startReindexer

public void startReindexer(boolean disablePostClearTasks)
                    throws com.sapportals.wcm.WcmException

Starts reindexing in a seperate thread.

Parameters:

disablePostClearTasks -

Throws:

com.sapportals.wcm.WcmException

startReindexerWithoutClear

public void startReindexerWithoutClear()
                                throws com.sapportals.wcm.WcmException

Starts reindexing without clearing the index in a seperate thread.

Throws:

com.sapportals.wcm.WcmException

deltaReindex

public void deltaReindex()
                  throws com.sapportals.wcm.WcmException

Performs indexing of the documents that are not indexed yet or have been changed since the last crawl. Additionally it deindexes documents from the index that have been indexed but now have been deleted. In contrast to the reindex calls this call doesn't clear the index.

Specified by:

deltaReindex in interface IIndex

Throws:

com.sapportals.wcm.WcmException - exception raised in failure situation

init

public void init(Properties properties)

Initializes the index with index implementation specific data

Specified by:

init in interface IIndex

Parameters:

properties - specific properties of the index implemenation

internalIndexDocuments

protected void internalIndexDocuments(IResourceList resources,
                                      IResourceEvent resourceEvent)
                               throws ResourceException,
                                      com.sapportals.wcm.WcmException,
                                      IOException

Indexes a list of documents

Parameters:

resources - resources to index

resourceEvent - event that caused the index request

Throws:

ResourceException - Exception raised in failure situation

com.sapportals.wcm.WcmException - Exception raised in failure situation

IOException - Exception raised in failure situation

internalDeindexDocuments

protected void internalDeindexDocuments(com.sapportals.wcm.util.uri.IRidList rids)
                                 throws ResourceException,
                                        com.sapportals.wcm.WcmException

Deindexes documents

Parameters:

rids - list of rids to deindex

Throws:

ResourceException - Exception raised in failure situation

com.sapportals.wcm.WcmException - Exception raised in failure situation

reindexXPostClear

protected boolean reindexXPostClear(IIndexFolderList preClearIndexFolders)
                             throws com.sapportals.wcm.WcmException

Throws:

com.sapportals.wcm.WcmException

getIndexFolderForDocument

public IIndexFolder getIndexFolderForDocument(com.sapportals.wcm.util.uri.RID documentRid)

Gets the next upper indexFolder for the document

Specified by:

getIndexFolderForDocument in interface IIndex

Parameters:

documentRid - rid of the document to get the index folder for

Returns:

index folder for document

reindexNotTrainingDocs

public void reindexNotTrainingDocs()
                            throws com.sapportals.wcm.WcmException

Throws:

com.sapportals.wcm.WcmException

compareTo

public int compareTo(Object o)

Compares two indexes

Parameters:

o -

Returns:

equals

public boolean equals(Object o)

Overrides:

equals in class Object

internalSetIndexFolders

public void internalSetIndexFolders(IIndexFolderList indexFolders)

For internal use only!

Parameters:

indexFolders -

getResourceInfo

public String getResourceInfo(com.sapportals.wcm.util.uri.RID documentRid)
                       throws com.sapportals.wcm.WcmException

Parameters:

documentRid -

Returns:

Throws:

com.sapportals.wcm.WcmException

See Also:

IIndex

getSystemList

public static ISystemList getSystemList()
                                 throws com.sapportals.wcm.WcmException

Checks and returns the system ID where the Indexmanagement Taskqueue Reader task should run.

Returns:

Throws:

com.sapportals.wcm.WcmException

setSchedulerTimeTable

public void setSchedulerTimeTable(ISchedulerTimeTable schedulerTimeTablePar)
                           throws com.sapportals.wcm.WcmException

Registers a schedule for delta index crawling for the index with the 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.

Specified by:

setSchedulerTimeTable in interface IIndex

Parameters:

schedulerTimeTablePar - ISchedulerTimeTable

Throws:

com.sapportals.wcm.WcmException - in case of an error.

getSchedulerTimeTable

public ISchedulerTimeTable getSchedulerTimeTable()
                                          throws com.sapportals.wcm.WcmException

Returns the timetable of a schedule for delta index crawling for the index. Returns null in case that no schedule is defined for the index. Remark: It is recommended to use the similar method of the IIndexService instead of this method.

Specified by:

getSchedulerTimeTable in interface IIndex

Returns:

ISchedulerTimeTable

Throws:

com.sapportals.wcm.WcmException - in case of an error.

isActive

public boolean isActive()

Returns the information if an index is available or has be set inactive.

Specified by:

isActive in interface IIndex

Returns:

true if index is active, false if index is inactive

setActive

public boolean setActive(boolean isActive)
                  throws com.sapportals.wcm.WcmException

Sets an index inactive or activates it.

Specified by:

setActive in interface IIndex

Parameters:

true - if index should be set to active, false if index should be deactivated

Returns:

true, if index has to be actualized after activating it, otherwise false

Throws:

com.sapportals.wcm.WcmException - in case of an error.

setActiveDuringStartup

public void setActiveDuringStartup(boolean isActive)
                            throws com.sapportals.wcm.WcmException

Description copied from interface: IIndex

Only for internal usage

Specified by:

setActiveDuringStartup in interface IIndex

Throws:

com.sapportals.wcm.WcmException

setInactiveIndexHasChanged

public void setInactiveIndexHasChanged()
                                throws com.sapportals.wcm.WcmException,
                                       ResourceException

Sets a property on true, if index documents have changed during index was inactive. The property is automatically deleted, if the index is reactivated, but the method for index reactivation returns true in that case, indicating that the index should be updated.

Specified by:

setInactiveIndexHasChanged in interface IIndex

Throws:

com.sapportals.wcm.WcmException - in case of an error

ResourceException - in case of an error

getRID

public com.sapportals.wcm.util.uri.RID getRID()
                                       throws com.sapportals.wcm.WcmException

Gets the resource ID of the resource representation of this index. Can return null if no indexmanagement repository prefix is configured.

Specified by:

getRID in interface IIndex

Returns:

resource ID of this index

Throws:

com.sapportals.wcm.WcmException - in case of an error.

checkIndexIsActive

public void checkIndexIsActive()
                        throws com.sapportals.wcm.WcmException

checks if index is active.

Throws:

com.sapportals.wcm.WcmException

setStateAndNumberOfCrawler

public void setStateAndNumberOfCrawler(AbstractIndex.IndexingState state,
                                       int numOfCrawler)
                                throws com.sapportals.wcm.WcmException

Only for internal usage.

Specified by:

setStateAndNumberOfCrawler in interface IIndex

Parameters:

i -

Throws:

com.sapportals.wcm.WcmException

setNumberOfCrawler

public void setNumberOfCrawler(int numOfCrawler)
                        throws ResourceException,
                               com.sapportals.wcm.WcmException

Parameters:

numOfCrawler -

Throws:

ResourceException

com.sapportals.wcm.WcmException

setIndexingState

public void setIndexingState(AbstractIndex.IndexingState state)
                      throws ResourceException,
                             com.sapportals.wcm.WcmException

Description copied from interface: IIndex

Only for internal usage

Specified by:

setIndexingState in interface IIndex

Throws:

com.sapportals.wcm.WcmException

ResourceException

repaireConfigurable

public void repaireConfigurable()
                         throws Exception

Only for internal usage.

Throws:

Exception

getNumberOfCrawler

public int getNumberOfCrawler(com.sapportals.wcm.util.uri.RID indexRid)
                       throws com.sapportals.wcm.WcmException

Only for internal usage.

Returns:

Throws:

com.sapportals.wcm.WcmException

reduceNumberOfCrawler

public int reduceNumberOfCrawler()
                          throws com.sapportals.wcm.WcmException

Only for internal usage.

Specified by:

reduceNumberOfCrawler in interface IIndex

Returns:

Throws:

com.sapportals.wcm.WcmException

getIndexingState

public AbstractIndex.IndexingState getIndexingState()
                                             throws ResourceException,
                                                    com.sapportals.wcm.WcmException

Returns the current state of the index.

Specified by:

getIndexingState in interface IIndex

Parameters:

indexRid -

Returns:

Throws:

com.sapportals.wcm.WcmException

ResourceException

getDetailsMonitorURL1

public String getDetailsMonitorURL1()
                             throws NotSupportedException

Get first details monitor

Returns:

Throws:

NotSupportedException - if the method is not implemented for an index

com.sapportals.wcm.WcmException

getDetailsMonitorURL2

public String getDetailsMonitorURL2()
                             throws NotSupportedException

Get second details monitor

Returns:

Throws:

NotSupportedException - if the method is not implemented for an index

com.sapportals.wcm.WcmException

getDetailsMonitorURL3

public String getDetailsMonitorURL3()
                             throws NotSupportedException

Get third details monitor

Returns:

Throws:

NotSupportedException - if the method is not implemented for an index

com.sapportals.wcm.WcmException

getDetailsMonitorPageURL

public String getDetailsMonitorPageURL()
                                throws NotSupportedException

Get details monitor portal page

Returns:

Throws:

NotSupportedException - if the method is not implemented for an index

com.sapportals.wcm.WcmException

getDetailsMonitorPageText

public String getDetailsMonitorPageText(Locale locale)
                                 throws NotSupportedException

Get Display Text for details monitor portal page

Returns:

Throws:

NotSupportedException - if the method is not implemented for an index

com.sapportals.wcm.WcmException

getFrameSizes

public String[] getFrameSizes()
                       throws NotSupportedException

Get frame sizes of detailed monitors (and implicit number of detailed monitors)

Returns:

Throws:

NotSupportedException - if the method is not implemented for an index

com.sapportals.wcm.WcmException

getErrorState

public AbstractIndex.ErrorState getErrorState(double errorThreshold,
                                              double warningThreshold,
                                              Locale locale)
                                       throws NotSupportedException

Returns an error state indicating the overall indexing status. The parameters decribes two borders. If the percentage of errors is over the first parameter an error status is returned. If it is over the second a warning status is returned.

Parameters:

errorThreshold -

warningThreshold -

locale -

Returns:

Throws:

NotSupportedException - if the method is not implemented for an index

getRunningState

public AbstractIndex.RunningState getRunningState()
                                           throws com.sapportals.wcm.WcmException

Returns a state indicating what is actually happening with respect to indexing.

Returns:

Throws:

NotSupportedException - if the method is not implemented for an index

com.sapportals.wcm.WcmException

getNumberOfSuccessfullyIndexedDocs

public int getNumberOfSuccessfullyIndexedDocs()
                                       throws com.sapportals.wcm.WcmException

Returns the numbers of documents successfully indexed and searchable.

Returns:

Throws:

NotSupportedException - if the method is not implemented for an index

com.sapportals.wcm.WcmException

getNumberOfDocumentsInQueue

public int getNumberOfDocumentsInQueue()
                                throws com.sapportals.wcm.WcmException

Returns the numbers of documents currently in work for indexing, but not in an error state.

Returns:

Throws:

NotSupportedException - if the method is not implemented for an index

com.sapportals.wcm.WcmException

getNumberOfErrors

public int getNumberOfErrors()
                      throws com.sapportals.wcm.WcmException

Returns the numbers of documents failed during indexing.

Returns:

Throws:

NotSupportedException - if the method is not implemented for an index

com.sapportals.wcm.WcmException

getNumberOfIndexErrors

public int getNumberOfIndexErrors(com.sapportals.wcm.util.uri.RID startRid)
                           throws com.sapportals.wcm.WcmException

Returns the number of crawler errors for the specified data source.

Parameters:

startRid -

Returns:

Throws:

com.sapportals.wcm.WcmException

getServiceErrorRids

public com.sapportals.wcm.util.uri.IRidList getServiceErrorRids(int maxNumber)
                                                         throws com.sapportals.wcm.WcmException

Returns the errors of the search or classification service for this index. This does not include errors with respect to the crawler service. The number of errors returned is restricted by maxNumber. If maxNumber is 0 all error rids are returned. If maxNumber is less than 0 no error rids are returned.

Parameters:

maxNumber -

Returns:

the rids of resources which are not indexed properly

Throws:

com.sapportals.wcm.WcmException

getActiveTime

public long getActiveTime()
                   throws com.sapportals.wcm.WcmException

Gives a rough estimation for the time duration needed for indexing the actual available documents.

Returns:

Throws:

NotSupportedException - if the method is not implemented for an index

com.sapportals.wcm.WcmException

getWhatToIndex

public AbstractIndex.WhatToIndex getWhatToIndex()

Returns is the index indexed collextions, simple resources of both.

Returns:

setWhatToIndex

public void setWhatToIndex(String s)

Description copied from interface: IIndex

Set what should be indexed (collections, simple resources or both)

Specified by:

setWhatToIndex in interface IIndex

getWhatToIndexString

public String getWhatToIndexString()

Description copied from interface: IIndex

String version of what is indexed (collection, simple resource, both)

Specified by:

getWhatToIndexString in interface IIndex

Returns:

isLogicalVariant

public static boolean isLogicalVariant(IResource res)

Checks if a resource is a logical variant.

Parameters:

res -

Returns:

isPhysicalVariant

public static boolean isPhysicalVariant(IResource res)

Checks if a resource is a physicalt.

Parameters:

res -

Returns:

typeShouldBeIndexed

public boolean typeShouldBeIndexed(IResource res)

Description copied from interface: IIndex

Checks if the type (collection, simple resource) shoulb be indexed.

Specified by:

typeShouldBeIndexed in interface IIndex

Returns:

getDisplayNameAsStringPropName

public static PropertyName getDisplayNameAsStringPropName()
                                                   throws ResourceException

Returns:

Throws:

ResourceException

getIndexFolderRidPropName

public static PropertyName getIndexFolderRidPropName()
                                              throws ResourceException

Returns:

Throws:

ResourceException

getDocumentFeaturesPropName

public static PropertyName getDocumentFeaturesPropName()
                                                throws ResourceException

Throws:

ResourceException

getLogicalOrPhysicalPropName

public static PropertyName getLogicalOrPhysicalPropName()
                                                 throws ResourceException

Throws:

ResourceException

getIndexOnlyPropertiesPropName

public static PropertyName getIndexOnlyPropertiesPropName()
                                                   throws ResourceException

Throws:

ResourceException

suspendAll

public void suspendAll()
                throws com.sapportals.wcm.WcmException

Suspends all running tasks for indexing.

Throws:

NotSupportedException - if the method is not implemented for an index

com.sapportals.wcm.WcmException

resumeAll

public void resumeAll()
               throws com.sapportals.wcm.WcmException

Resumes all suspended tasks for indexing.

Throws:

NotSupportedException - if the method is not implemented for an index

com.sapportals.wcm.WcmException

stopAll

public void stopAll()
             throws com.sapportals.wcm.WcmException

Stops all running tasks for indexing.

Throws:

NotSupportedException - if the method is not implemented for an index

com.sapportals.wcm.WcmException

restartAll

public void restartAll()
                throws com.sapportals.wcm.WcmException

Stops all stopped and suspended tasks for indexing.

Throws:

NotSupportedException - if the method is not implemented for an index

com.sapportals.wcm.WcmException

indexStringAttributeAsString

public static boolean indexStringAttributeAsString(IMetaName metaName)

Returns true if the attribute is indexed as a string and false if indexed as text. The property has to be modelled otherwise false is returned.

Parameters:

metaName -

Returns:

indexInternalLinks

public boolean indexInternalLinks()

Description copied from interface: IIndex

Checks if internal links should be indexed.

Specified by:

indexInternalLinks in interface IIndex

Returns:

flush

public boolean flush(com.sapportals.wcm.util.uri.RID rid,
                     int counter)
              throws com.sapportals.wcm.WcmException

Tries about counter of times to bring the documents decribed by the rid in a state such that the document can be found in the index. If this is possible, true is returned otherwise false.

Parameters:

rid -

counter -

Returns:

Throws:

com.sapportals.wcm.WcmException

flushAsync

public void flushAsync(com.sapportals.wcm.util.uri.RID rid,
                       int counter)
                throws com.sapportals.wcm.WcmException

Asynchronous flush.

Parameters:

rid -

counter -

Throws:

com.sapportals.wcm.WcmException

flush

public void flush()
           throws com.sapportals.wcm.WcmException

Flushes the queue

Throws:

com.sapportals.wcm.WcmException

flushAsync

public void flushAsync()
                throws com.sapportals.wcm.WcmException

Asynchronous flush.

Throws:

com.sapportals.wcm.WcmException

isInSystemFolder

public static boolean isInSystemFolder(com.sapportals.wcm.util.uri.RID currRid)

Parameters:

currRid -

Returns:

getHiddenIndexIds

public static Map getHiddenIndexIds()
                             throws ResourceException

only for internal usage

Returns:

Throws:

ResourceException

indexContentOfExternalLinks

public boolean indexContentOfExternalLinks()

Checks if the content of external links should be indexed.

Returns:

getPropertiesForHiddenResource

public IPropertyMap getPropertiesForHiddenResource(com.sapportals.wcm.util.uri.RID rid)
                                            throws com.sapportals.wcm.WcmException

Returns the properties for the resource specified by the rid.

Parameters:

rid -

Returns:

Throws:

com.sapportals.wcm.WcmException

getContent

public IContent getContent(com.sapportals.wcm.util.uri.RID rid)
                    throws com.sapportals.wcm.WcmException

Returns the content for the specified ridList.

Parameters:

ridList -

Returns:

Throws:

com.sapportals.wcm.WcmException

getOriginalContent

public Collection getOriginalContent(com.sapportals.wcm.util.uri.IRidList ridList)
                              throws com.sapportals.wcm.WcmException

Returns the content for the specified ridList.

Parameters:

ridList -

Returns:

Throws:

com.sapportals.wcm.WcmException

getNumberOfIndexedDocuments

public int getNumberOfIndexedDocuments(IIndexFolder indexFolder,
                                       IResourceContext context)
                                throws NotSupportedException

Returns the number of documents of the datasource of the index which are already in the index. -1 is returned if the number cannot be returned.

Parameters:

indexFolder -

context -

Returns:

Throws:

NotSupportedException - if the method is not implemented by the index type.

getHiddenIndexAreaStartRid

public com.sapportals.wcm.util.uri.RID getHiddenIndexAreaStartRid()

Returns the start rid of an hidden index

Returns:

getSecManager

public DefaultIMSecurityManager getSecManager()
                                       throws ResourceException

Only for internal usage

Returns:

Throws:

ResourceException

getQueryExtender

public DefaultQueryExtender getQueryExtender()
                                      throws ResourceException

Only for internal usage

Returns:

Throws:

ResourceException

setQueryExtender

public void setQueryExtender(DefaultQueryExtender extender)

Only for internal usage.

Parameters:

extender -

getHighlightedContent

public Collection getHighlightedContent(ISearchResultList searchResults,
                                        IQueryEntryList queryList)
                                 throws com.sapportals.wcm.WcmException

gets the hightlighted content of resources with respect to the queryList

Parameters:

searchResults - search result list with resources for which content have to be returned

queryList - the queries to be highlighted

Returns:

Collection of ITextminingResult

Throws:

com.sapportals.wcm.WcmException

getHighlightedContent

public Collection getHighlightedContent(ISearchResultList searchResults,
                                        IQueryEntryList queryList,
                                        boolean anchorlinks)
                                 throws com.sapportals.wcm.WcmException

gets the hightlighted content of resources with respect to the queryList

Parameters:

searchResults - search result list with resources for which content have to be returned

queryList - the queries to be highlighted

anchorlinks - if true anchorlinks to the highlighted term are presented

Returns:

Collection of ITextminingResult

Throws:

com.sapportals.wcm.WcmException

onlyVirtualDatasources

public boolean onlyVirtualDatasources()

getClassProperties

public HashSet getClassProperties()
                           throws ResourceException

Throws:

ResourceException

setClassProperties

public void setClassProperties(HashSet set)

getSimilarClasses

public List getSimilarClasses(IPropertyName propName,
                              String value,
                              int maxResults)
                       throws com.sapportals.wcm.WcmException

Description copied from interface: IIndex

The method returns similar property values to the input value with respect to specified property. Only modeled and indexable properites indexed as strings could be used here.

Specified by:

getSimilarClasses in interface IIndex

Returns:

Throws:

com.sapportals.wcm.WcmException

changeIndexedDocumentProperties

public void changeIndexedDocumentProperties(com.sapportals.wcm.util.uri.RID rid,
                                            IPropertyMap addProperties,
                                            IPropertyMap deleteProperties,
                                            IPropertyNameList deleteValues,
                                            IProperty testProperty)
                                     throws com.sapportals.wcm.WcmException

Description copied from interface: IIndex

This method adds and deletes property values for a particular resource on the index server. For Trex, this method could only be used for date, timestamp, integer attributes as well as attributes which are indexed as strings on the Trex server. If testProperty is set, i.e. not equal null, the method first checks if the resource with this property is already in the index. If not, the resource is reindexed completely and the method stops. If testProperty is null or if the resource with the property value testValue is in the index, the following steps are executed in that order: - All former property values of properties listed in deleteValues are deleted. This parameter might be null if nothing should be deleted completely. - The property values defined in deleteProperties are deleted from the indexed resource. - The property values defined in addProperties are added to the indexed resource.

Specified by:

changeIndexedDocumentProperties in interface IIndex

Throws:

com.sapportals.wcm.WcmException

changeIndexedDocumentProperties

public void changeIndexedDocumentProperties(com.sapportals.wcm.util.uri.RID rid,
                                            IPropertyMap addProperties,
                                            IPropertyMap deleteProperties,
                                            IPropertyNameList deleteValues,
                                            boolean testQueue)
                                     throws com.sapportals.wcm.WcmException

Description copied from interface: IIndex

This method adds and deletes property values for a particular resource on the index server. For Trex, this method could only be used for date, timestamp, integer attributes as well as attributes which are indexed as strings on the Trex server. If testQueue is set on true, the method first checks if the resource with this property is already in the index by checking the index queue. If not, the resource is reindexed completely and the method stops. If testProperty is false or if the resource is in the index according to the queue information, the following steps are executed in that order: - All former property values of properties listed in deleteValues are deleted. This parameter might be null if nothing should be deleted completely. - The property values defined in deleteProperties are deleted from the indexed resource. - The property values defined in addProperties are added to the indexed resource.

Specified by:

changeIndexedDocumentProperties in interface IIndex

Throws:

com.sapportals.wcm.WcmException

changeIndexedDocumentProperties

public List changeIndexedDocumentProperties(com.sapportals.wcm.util.uri.RID rid,
                                            IPropertyMap addProperties,
                                            IPropertyMap deleteProperties,
                                            IPropertyMap defineProperties)
                                     throws NotSupportedException

Description copied from interface: IIndex

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. For Trex, this method could only be used for date, timestamp, integer attributes as well as attributes which are indexed as strings on the Trex server.

Specified by:

changeIndexedDocumentProperties in interface IIndex

Parameters:

rid - RID of the resource

addProperties - Properties which should added to the resource

deleteProperties - Properties which should deleted from the resource

defineProperties - Properties for which the definition has to be send to the server first, because until now no indexed document already contains it

Throws:

NotSupportedException

deindex

public void deindex(IQueryEntryList query)
             throws com.sapportals.wcm.WcmException

Description copied from interface: IIndex

This method deindexes all resources from the index server fullfilling the query.

Specified by:

deindex in interface IIndex

Throws:

com.sapportals.wcm.WcmException

Access Rights

This class can be accessed from:

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] tc/km/frwk	api	EP-KM-CM