com.sapportals.wcm.service.indexmanagement.helperclasses

Class IndexCreationHelper

java.lang.Object
  com.sapportals.wcm.service.indexmanagement.helperclasses.IndexCreationHelper

public final class IndexCreationHelper
extends Object

Helper class to create indexes

Field Summary

static String

WHAT_TO_INDEX

Constructor Summary

IndexCreationHelper()

Method Summary

static IIndex	createTrexClassificationIndex(String indexId, String indexName, String indexGroup, Properties indexProperties, Map additionalProperties, IResourceList dataSources) Creates a Trex classification index
static IIndex	createTrexSearchAndClassificationIndex(String indexId, String indexName, String indexGroup, Properties indexProperties, Map additionalProperties, IResourceList dataSources) Creates a Trex search and classification index
static IIndex	createTrexSearchIndex(String indexId, String indexName, String indexGroup, Properties indexProperties, Map additionalProperties, IResourceList dataSources) Creates a Trex search index

Methods inherited from class java.lang.Object

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

Field Detail

WHAT_TO_INDEX

public static final String WHAT_TO_INDEX

See Also:

Constant Field Values

Constructor Detail

IndexCreationHelper

public IndexCreationHelper()

Method Detail

createTrexSearchAndClassificationIndex

public static IIndex createTrexSearchAndClassificationIndex(String indexId,
                                                            String indexName,
                                                            String indexGroup,
                                                            Properties indexProperties,
                                                            Map additionalProperties,
                                                            IResourceList dataSources)
                                                     throws com.sapportals.wcm.WcmException

Creates a Trex search and classification index

Parameters:

indexId - id of the index, might not be null

indexName - name of the index, might not be null

indexGroup - group of the index, might be null

indexProperties - additional properties of the index, might be null; only Strings could be used as keys and properties

additionalProperties - to specify index details (might be null) - the following possiblities exists, whereby all keys are of type String: - key = whatToIndex, value = AbstractIndex.WhatToIndex - determines if documents, folders or both will be indexed

dataSources - list of resource used as datasources for the index, might be null

Throws:

com.sapportals.wcm.WcmException

createTrexSearchIndex

public static IIndex createTrexSearchIndex(String indexId,
                                           String indexName,
                                           String indexGroup,
                                           Properties indexProperties,
                                           Map additionalProperties,
                                           IResourceList dataSources)
                                    throws com.sapportals.wcm.WcmException

Creates a Trex search index

Parameters:

indexId - id of the index, might not be null

indexName - name of the index, might not be null

indexGroup - group of the index, might be null

indexProperties - additional properties of the index, might be null; only Strings could be used as keys and properties

additionalProperties - to specify index details (might be null) - the following possiblities exists, whereby all keys are of type String: - key = whatToIndex, value = AbstractIndex.WhatToIndex - determines if documents, folders or both will be indexed

dataSources - list of resource used as datasources for the index, might be null

Throws:

com.sapportals.wcm.WcmException

createTrexClassificationIndex

public static IIndex createTrexClassificationIndex(String indexId,
                                                   String indexName,
                                                   String indexGroup,
                                                   Properties indexProperties,
                                                   Map additionalProperties,
                                                   IResourceList dataSources)
                                            throws com.sapportals.wcm.WcmException

Creates a Trex classification index

Parameters:

indexId - id of the index, might not be null

indexName - name of the index, might not be null

indexGroup - group of the index, might be null

indexProperties - additional properties of the index, might be null; only Strings could be used as keys and properties - examples are (IndexInternalLinks = true etc.)

additionalProperties - to specify index details (might be null) - the following possiblities exists, whereby all keys are of type String: - key = whatToIndex, value = AbstractIndex.WhatToIndex - determines if documents, folders or both will be indexed

dataSources - list of resource used as datasources for the index, might be null

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