com.plumtree.server
Interface IPTTaxonomist

All Superinterfaces:
IPTLocalizable, IPTObject, IPTServerContext, IPTStorable, IPTUnknown

public interface IPTTaxonomist
extends IPTObject

This class defines an object that performs taxonomization. Taxonomization is the process of classifying Documents into a set of Folders by using Filters, which define folder membership.

Version:
$Revision$
Author:
StephenC

Method Summary
 void AddDestinationFolder(int lFolderID)
          Adds a particular Folder to the list of Target Folders
 void AddSourceFolder(int lFolderID)
          Adds a particular Folder to the list of Source Folders
 void AddToBulkProfile(IPTCard pCard, java.lang.String bstrProvCLSID)
          Adds a Card to the Profiling Engine for taxonomization
 java.lang.Object[][] CommitBulkProfile(int pm)
          Commits the profiled Cards to the index
 java.lang.Object[] GetDestinationFolders()
          Returns the target Folders for this Taxonomist.
 java.lang.String GetFallBackLocale()
          Retrieves the language of the Taxonomist
 int GetFilterCount()
          Returns the number of Filters assigned to the Profiling Engine
 int GetSettings()
          Retrieves the settings stored on this Taxonomist in the form of a bitmap.
 java.lang.Object[] GetSourceFolders()
          Retrieves the Source Folders of this Taxonomist.
 int GetUnclassifiedSubFolderID()
          Returns the Unclassified Subfolder that is associated with this Taxonomist.
 void Initialize(IPTSession pSession)
          Initializes the Taxonomist by associated it with an IPTSession.
 void RemoveDestinationFolder(int lFolderID)
          Removes a particular Folder from the list of Target Folders
 void RemoveSourceFolder(int lFolderID)
          Removes a particular Folder from the list of Source Folders
 void SetDestinationFolders(java.lang.Object[] Value)
          Sets the target Folders for this Taxonomist.
 void SetFallBackLocale(java.lang.String Value)
          Sets the language of the Taxonomist
 void SetSettings(int Value)
          Sets the settings associated with this Taxonomist.
 void SetSourceFolders(java.lang.Object[] Value)
          Sets the Source Folders of this Taxonomist.
 int[] TaxonomizeCard(IPTCard pCard)
          Taxonomizes a Card into the Target Folders.
 
Methods inherited from interface com.plumtree.server.IPTObject
GetAdminFolderID, GetClassID, GetCreated, GetImageUUID, GetLastModified, GetObjectProperties, SetAdminFolderID, SetImageUUID, SetLastModified
 
Methods inherited from interface com.plumtree.server.IPTLocalizable
GetDescription, GetIsLocalized, GetLocalizedDescription, GetLocalizedDescriptions, GetLocalizedName, GetLocalizedNames, GetName, GetPrimaryLang, GetSupportsLocalization, SetDescription, SetIsLocalized, SetLocalizedDescriptions, SetLocalizedNames, SetName, SetPrimaryLang
 
Methods inherited from interface com.plumtree.server.IPTUnknown
GetInterfaces
 
Methods inherited from interface com.plumtree.server.IPTServerContext
GetAccessLevel, GetACL, GetLastModifiedBy, GetLockState, GetObjectID, GetOwnerID, GetServerContextSettings, GetSession, GetSettings, LockObject, SetLastModifiedBy, SetObjectID, SetOwnerID, SetServerContextSettings, SetSettings, UnlockObject
 
Methods inherited from interface com.plumtree.server.IPTStorable
Store
 

Method Detail

GetDestinationFolders

java.lang.Object[] GetDestinationFolders()
Returns the target Folders for this Taxonomist.

Returns:
Integer array of the target Folder IDs

SetDestinationFolders

void SetDestinationFolders(java.lang.Object[] Value)
Sets the target Folders for this Taxonomist.

Parameters:
Value - Integer array of the target Folder IDs

AddDestinationFolder

void AddDestinationFolder(int lFolderID)
Adds a particular Folder to the list of Target Folders

Parameters:
lFolderID - ID of the Target Folder being added

RemoveDestinationFolder

void RemoveDestinationFolder(int lFolderID)
Removes a particular Folder from the list of Target Folders

Parameters:
nFolderID - folder ID of the target folder being removed.

GetSettings

int GetSettings()
Retrieves the settings stored on this Taxonomist in the form of a bitmap.

Returns:
Settings in the form of a bitmap
See Also:
PT_TAXONOMIST_SETTINGS

SetSettings

void SetSettings(int Value)
Sets the settings associated with this Taxonomist. Note that this call overwrites the current settings.

Parameters:
nValue - settings in the form of a bitmap
See Also:
PT_TAXONOMIST_SETTINGS

GetSourceFolders

java.lang.Object[] GetSourceFolders()
Retrieves the Source Folders of this Taxonomist.

Returns:
Integer array of the source Folder IDs

SetSourceFolders

void SetSourceFolders(java.lang.Object[] Value)
Sets the Source Folders of this Taxonomist.

Parameters:
Value - Integer array of the source Folder IDs

AddSourceFolder

void AddSourceFolder(int lFolderID)
Adds a particular Folder to the list of Source Folders

Parameters:
lFolderID - ID of the Source Folder being added

RemoveSourceFolder

void RemoveSourceFolder(int lFolderID)
Removes a particular Folder from the list of Source Folders

Parameters:
nFolderID - folder ID of the source folder being removed.

Initialize

void Initialize(IPTSession pSession)
Initializes the Taxonomist by associated it with an IPTSession.

Parameters:
pSession - Session to be associated with the Taxonomist

TaxonomizeCard

int[] TaxonomizeCard(IPTCard pCard)
Taxonomizes a Card into the Target Folders.

Parameters:
pCard - Card to be Taxonomized
Returns:
array of folderIDs that the Card was taxonomized into.

AddToBulkProfile

void AddToBulkProfile(IPTCard pCard,
                      java.lang.String bstrProvCLSID)
Adds a Card to the Profiling Engine for taxonomization

Parameters:
pCard - Card to be Taxonomized by the Profiler
bstrProvCLSID - Provider identifier

CommitBulkProfile

java.lang.Object[][] CommitBulkProfile(int pm)
Commits the profiled Cards to the index

Parameters:
pm - Profiler mode
Returns:
status flags
See Also:
PT_PROFILER_MODE

GetUnclassifiedSubFolderID

int GetUnclassifiedSubFolderID()
Returns the Unclassified Subfolder that is associated with this Taxonomist. If such a Folder does not yet exist, one is created.

Returns:
folderID of the Unclassified Subfolder.

GetFilterCount

int GetFilterCount()
Returns the number of Filters assigned to the Profiling Engine

Returns:
number of Filters assigned to the Profiling Engine

GetFallBackLocale

java.lang.String GetFallBackLocale()
Retrieves the language of the Taxonomist

Returns:
Language string

SetFallBackLocale

void SetFallBackLocale(java.lang.String Value)
Sets the language of the Taxonomist

Parameters:
Value - Language string


Copyright 2008 Plumtree Software Inc. All Rights Reserved.