|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPTCrawler
Method Summary | |
---|---|
int |
ClearCardRejectsMemory(boolean bExecute)
Produces tally and optionally purges crawler history of previously rejected cards. |
int |
ClearDeletedCardsMemory(boolean bExecute,
boolean bScopeDataSource)
Produces tally and optionally purges crawler history of previously deleted cards. |
IPTAccessList |
GetCardACL()
Returns the Access Control List assigned to cards created by this crawler. |
void |
GetCardExpirationDelay(java.lang.Object plTimeUnits,
java.lang.Object plNumber)
Deprecated. |
int |
GetCardExpirationDelayUnits()
Returns the time units expressed as a PT_SCHEDULETYPES used to compute the expiration rate for cards brought in by this crawler. |
int |
GetCardExpirationDelayValue()
Returns the number of units used to compute the expiration delay. |
void |
GetCardMissingDocumentDeletionDelay(java.lang.Object plTimeUnits,
java.lang.Object plNumber)
Deprecated. |
int |
GetCardMissingDocumentDeletionDelayUnits()
Returns the time units expressed as a PT_SCHEDULETYPES used to compute the missing deletion delay rate for cards brought in by this crawler. |
int |
GetCardMissingDocumentDeletionDelayValue()
Returns the number of units used to compute the missing document deletion delay. |
void |
GetCardRefreshRate(java.lang.Object plTimeUnits,
java.lang.Object plNumber)
Deprecated. |
int |
GetCardRefreshRateUnits()
Returns the time units expressed as a PT_SCHEDULETYPES used to compute the card refresh rate for cards brought in by this crawler. |
int |
GetCardRefreshRateValue()
Returns the number of units used to compute the next card refresh rate |
java.lang.Object[][] |
GetCardRefreshSetting(int lRefreshSetting)
For any requested PT_CARDREFRESHSETTING, returns a 2D array of dimensions [0][2], the first two elements of which contain the values for the number of units and their size (PT_SCHEDULETYPES) accordingly. |
boolean |
GetCheckLinkOnly()
Determines whether the crawler has been configured to mark its cards for link validation only. |
java.lang.String |
GetContentLanguage()
Returns the two character language designation determining how text retrieved from source documents will be indexed. |
java.lang.String |
GetCrawlDescription()
Gets a human readable description of the intended crawl activity. |
com.plumtree.openfoundation.util.IXPPropertyBag |
GetCrawlerRuntimeConfiguration()
|
java.lang.String |
GetCrawlerTag()
Gets the current value each of the cards brought in by this crawler will inherit for their Crawler Tag property. |
int |
GetDataSourceID()
Returns the ID identifying the single data source on which this crawler depends. |
IPTDocumentTypeMap |
GetDocumentTypeMap()
Retrieves a reference to the IPTDocumentTypeMap object used to determine which Document Type should apply to incoming documents based on a file extension or MIME type. |
int |
GetSettings()
Returns a value representing an OR'd list of PT_CRAWLER_SETTINGS. |
com.plumtree.openfoundation.util.IXPPropertyBag |
GetStartLocation()
Retrieves the start location or root node designation for the crawl. |
IPTTaxonomist |
GetTaxonomist()
Returns a reference to the crawler's taxonomist component containing a combination of settings for card classification behavior. |
void |
Initialize(int lDataSourceID)
Initializes internal crawler resources From the Data Source, the Crawler can get the supported data formats from the Data Source Provider Registry and then go to the Top Level Document Type Map and pick out the sections it needs (or is relevant) in the Crawler. |
void |
SetCardExpirationDelay(int lTimeUnits,
int lNumber)
Sets the expiration delay for cards created by this crawler. |
void |
SetCardMissingDocumentDeletionDelay(int lTimeUnits,
int lNumber)
Sets the missing deletion delay for cards created by this crawler. |
void |
SetCardRefreshRate(int lTimeUnits,
int lNumber)
Sets the card refresh interval for cards created by this crawler. |
void |
SetCheckLinkOnly(boolean Value)
Configures the crawler to mark its cards for link validation only or not. |
void |
SetContentLanguage(java.lang.String Value)
Sets the two character language designation determining how text retrieved from source documents will be indexed. |
void |
SetCrawlerRuntimeConfiguration(com.plumtree.openfoundation.util.IXPPropertyBag Value)
Set the property bag representing the runtime configuration parameters for this crawler. |
void |
SetCrawlerTag(java.lang.String Value)
Gets the current value each of the cards brought in by this crawler will inherit for their Crawler Tag property. |
void |
SetSettings(int Value)
Sets a value representing an OR'd list of PT_CRAWLER_SETTINGS. |
void |
SetStartLocation(com.plumtree.openfoundation.util.IXPPropertyBag Value)
Sets the start location or root node designation for the crawl. |
void |
SetStartLocation(java.lang.String Value)
Sets the start location or root node designation for the crawl. |
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 |
---|
void Initialize(int lDataSourceID)
lDataSourceID
- The ID identifying the single data source on which this crawler depends.int GetDataSourceID()
IPTDocumentTypeMap GetDocumentTypeMap()
IPTTaxonomist GetTaxonomist()
int GetSettings()
void SetSettings(int Value)
Value
- An int value resulting from an OR'd product of PT_CRAWLER_SETTINGS.com.plumtree.openfoundation.util.IXPPropertyBag GetStartLocation()
void SetStartLocation(java.lang.String Value)
Value
- a String specifying this crawl's start location.void SetStartLocation(com.plumtree.openfoundation.util.IXPPropertyBag Value)
Value
- a property bag specifying this crawl's start location.java.lang.String GetCrawlDescription()
int ClearCardRejectsMemory(boolean bExecute)
bExecute
- If passed as true, purges rejected card history.
int ClearDeletedCardsMemory(boolean bExecute, boolean bScopeDataSource)
bExecute
- If passed as true, purges deleted card history.
IPTAccessList GetCardACL()
void GetCardRefreshRate(java.lang.Object plTimeUnits, java.lang.Object plNumber)
plTimeUnits
- An Integer to hold the PT_SCHEDULETYPES value.plNumber
- An Integer to hold the number of time units applied.void SetCardRefreshRate(int lTimeUnits, int lNumber)
plTimeUnits
- An int indicating the PT_SCHEDULETYPES value.plNumber
- An int indicating the number of time units applied.void GetCardMissingDocumentDeletionDelay(java.lang.Object plTimeUnits, java.lang.Object plNumber)
plTimeUnits
- An Integer to hold the PT_SCHEDULETYPES value.plNumber
- An Integer to hold the number of time units applied.void SetCardMissingDocumentDeletionDelay(int lTimeUnits, int lNumber)
plTimeUnits
- An int indicating the PT_SCHEDULETYPES value.plNumber
- An int indicating the number of time units applied.void GetCardExpirationDelay(java.lang.Object plTimeUnits, java.lang.Object plNumber)
plTimeUnits
- An Integer to hold the PT_SCHEDULETYPES value.plNumber
- An Integer to hold the number of time units applied.void SetCardExpirationDelay(int lTimeUnits, int lNumber)
plTimeUnits
- An int indicating the PT_SCHEDULETYPES value.plNumber
- An int indicating the number of time units applied.boolean GetCheckLinkOnly()
void SetCheckLinkOnly(boolean Value)
Value
- a boolean, if true sets link validation only.java.lang.Object[][] GetCardRefreshSetting(int lRefreshSetting)
lRefreshSetting
- a PT_CARDREFRESHSETTING
int GetCardRefreshRateUnits()
int GetCardRefreshRateValue()
int GetCardMissingDocumentDeletionDelayUnits()
int GetCardMissingDocumentDeletionDelayValue()
int GetCardExpirationDelayUnits()
int GetCardExpirationDelayValue()
java.lang.String GetContentLanguage()
void SetContentLanguage(java.lang.String Value)
a
- String containing a two letter language codejava.lang.String GetCrawlerTag()
void SetCrawlerTag(java.lang.String Value)
a
- String containing the user supplied crawler tag.void SetCrawlerRuntimeConfiguration(com.plumtree.openfoundation.util.IXPPropertyBag Value)
Value
- - the property bag containing all the crawler runtime configuration values.com.plumtree.openfoundation.util.IXPPropertyBag GetCrawlerRuntimeConfiguration()
SetCrawlerRuntimeConfiguration(IXPPropertyBag)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |