com.sapportals.wcm.service.indexmanagement.retrieval.classification
Interface ITaxonomyTransport

[contained in: com.sap.km.cm.service.par - km.shared.service.indexmanagement_api.jar]

public interface ITaxonomyTransport

This interface is only for internal usage

Field Summary

static java.lang.String	EXPORT_EMPTY_SUB_QUERY_ERROR
static java.lang.String	EXPORT_FATAL_ERROR
static java.lang.String	EXPORT_INITIAL_STATE
static java.lang.String	EXPORT_MISSING_CLOSING_BRACKET_ERROR
static java.lang.String	EXPORT_MISSING_OPENING_BRACKET_ERROR
static java.lang.String	EXPORT_MISSING_OPERATOR_IN_COMPLEX_QUERY_ERROR
static java.lang.String	EXPORT_MISSING_SIMPLE_QUERY_ERROR
static java.lang.String	EXPORT_OK
static java.lang.String	EXPORT_UNMODELLED_ATTRIBUTE_ERROR
static java.lang.String	EXPORT_WRONG_OPERATOR_FOR_CONTENT_QUERY_ERROR
static java.lang.String	EXPORT_WRONG_OPERATOR_FOR_OTHER_QUERY_ERROR
static java.lang.String	EXPORT_WRONG_OPERATOR_FOR_TEXT_QUERY_ERROR
static java.lang.String	IMPORT_ATTRIBUTE_NOT_MODELLED_ERROR
static java.lang.String	IMPORT_ATTRIBUTE_TYPE_ERROR
static java.lang.String	IMPORT_DTD_ERROR
static java.lang.String	IMPORT_FATAL_ERROR
static java.lang.String	IMPORT_INITIAL_STATE
static java.lang.String	IMPORT_OK
static java.lang.String	IMPORT_PARSING_ERROR
static java.lang.String	IMPORT_QUERY_FOR_EB_TAX_ERROR
static java.lang.String	IMPORT_TAX_ALREADY_EXISTS_ERROR
static java.lang.String	IMPORT_TAXONOMY_CREATION_ERROR

Method Summary

IResource	exportDTD(ICollection exportColl)
void	exportTaxonomy(ICollection collection, java.lang.String outputResource, IClassificationIndex index, java.lang.String taxname) Exports a taxonomy to a resource.
java.lang.String	getDuration() Returns the duration of the last import or export operation in the following format hh:mm:ss
java.lang.String	getErrorMessage() Returns a more detailed message about what happend during ex- or import.
int	getNumberOfCategories() Returns the number of categories of the last import or export operation.
java.lang.String	getState() After an ex- or import of a taxonomy, you could check the success or problems of this opertation by looking at the state.
java.lang.String	getTaxonomyName()
void	importTaxonomy(IResource taxDocument, IClassificationIndex index) Imports a taxonomy.

Field Detail

IMPORT_INITIAL_STATE

public static final java.lang.String IMPORT_INITIAL_STATE

IMPORT_PARSING_ERROR

public static final java.lang.String IMPORT_PARSING_ERROR

IMPORT_TAX_ALREADY_EXISTS_ERROR

public static final java.lang.String IMPORT_TAX_ALREADY_EXISTS_ERROR

IMPORT_FATAL_ERROR

public static final java.lang.String IMPORT_FATAL_ERROR

IMPORT_TAXONOMY_CREATION_ERROR

public static final java.lang.String IMPORT_TAXONOMY_CREATION_ERROR

IMPORT_ATTRIBUTE_NOT_MODELLED_ERROR

public static final java.lang.String IMPORT_ATTRIBUTE_NOT_MODELLED_ERROR

IMPORT_ATTRIBUTE_TYPE_ERROR

public static final java.lang.String IMPORT_ATTRIBUTE_TYPE_ERROR

IMPORT_QUERY_FOR_EB_TAX_ERROR

public static final java.lang.String IMPORT_QUERY_FOR_EB_TAX_ERROR

IMPORT_DTD_ERROR

public static final java.lang.String IMPORT_DTD_ERROR

IMPORT_OK

public static final java.lang.String IMPORT_OK

EXPORT_INITIAL_STATE

public static final java.lang.String EXPORT_INITIAL_STATE

EXPORT_FATAL_ERROR

public static final java.lang.String EXPORT_FATAL_ERROR

EXPORT_MISSING_OPENING_BRACKET_ERROR

public static final java.lang.String EXPORT_MISSING_OPENING_BRACKET_ERROR

EXPORT_MISSING_CLOSING_BRACKET_ERROR

public static final java.lang.String EXPORT_MISSING_CLOSING_BRACKET_ERROR

EXPORT_MISSING_SIMPLE_QUERY_ERROR

public static final java.lang.String EXPORT_MISSING_SIMPLE_QUERY_ERROR

EXPORT_UNMODELLED_ATTRIBUTE_ERROR

public static final java.lang.String EXPORT_UNMODELLED_ATTRIBUTE_ERROR

EXPORT_WRONG_OPERATOR_FOR_TEXT_QUERY_ERROR

public static final java.lang.String EXPORT_WRONG_OPERATOR_FOR_TEXT_QUERY_ERROR

EXPORT_WRONG_OPERATOR_FOR_CONTENT_QUERY_ERROR

public static final java.lang.String EXPORT_WRONG_OPERATOR_FOR_CONTENT_QUERY_ERROR

EXPORT_WRONG_OPERATOR_FOR_OTHER_QUERY_ERROR

public static final java.lang.String EXPORT_WRONG_OPERATOR_FOR_OTHER_QUERY_ERROR

EXPORT_EMPTY_SUB_QUERY_ERROR

public static final java.lang.String EXPORT_EMPTY_SUB_QUERY_ERROR

EXPORT_MISSING_OPERATOR_IN_COMPLEX_QUERY_ERROR

public static final java.lang.String EXPORT_MISSING_OPERATOR_IN_COMPLEX_QUERY_ERROR

EXPORT_OK

public static final java.lang.String EXPORT_OK

Method Detail

importTaxonomy

public void importTaxonomy(IResource taxDocument,
                           IClassificationIndex index)
                    throws java.lang.Exception

Imports a taxonomy. A taxonomy decribed in a XML resource is build up as a new taxonomy for the specified index.

Parameters:

taxDocument - XML resource describing the taxonomy to import

index - index to which the new taxonomy is attached

Throws:

java.lang.Exception -

exportTaxonomy

public void exportTaxonomy(ICollection collection,
                           java.lang.String outputResource,
                           IClassificationIndex index,
                           java.lang.String taxname)
                    throws java.lang.Exception

Exports a taxonomy to a resource. The taxonomy is described in XML.

Parameters:

collection - Collection where the resource with the exported taxonomjy is stored.

outputResource - Resource where the exported taxonomy is stored

index -

taxname - Name of the taxonomy to export

Throws:

java.lang.Exception -

getState

public java.lang.String getState()

After an ex- or import of a taxonomy, you could check the success or problems of this opertation by looking at the state. The possible states are described in this interface.

Returns:

getErrorMessage

public java.lang.String getErrorMessage()

Returns a more detailed message about what happend during ex- or import.

Returns:

exportDTD

public IResource exportDTD(ICollection exportColl)
                    throws NotSupportedException,
                           AccessDeniedException,
                           ResourceException

Parameters:

exportColl -

getDuration

public java.lang.String getDuration()

Returns the duration of the last import or export operation in the following format hh:mm:ss

Returns:

getNumberOfCategories

public int getNumberOfCategories()

Returns the number of categories of the last import or export operation.

Returns:

getTaxonomyName

public java.lang.String getTaxonomyName()