com.plumtree.portalpages.admin.editors.crawler
Class CrawlerModel

java.lang.Object
  com.plumtree.uiinfrastructure.editor.EditorModel
      com.plumtree.portaluiinfrastructure.editor.ObjEditorModel
          com.plumtree.portalpages.admin.editors.crawler.CrawlerModel

All Implemented Interfaces:

ICrawlerModelRO, IDescriptionModelRO, IMigrationModelRO, IObjEditorModelRO, IManagedObject, IModel, IModelRO, IMVCObject, IEditorModelRO, IRepostModel

Direct Known Subclasses:

SOAPCrawlerModel, WWWCrawlerModel

public abstract class CrawlerModel
extends ObjEditorModel
implements ICrawlerModelRO

This is the main Editor Model for the Crawler Editor.

Author:

Julie Fournier

Field Summary

protected IXPPropertyBag	crawlerRuntimeConfig Crawler Runtime Configuration Property Bag Put infomation about the number of threads, etc.
boolean	m_bDisplayMirroringAlert When the mirroring check box is checked, the destination folders selection becomes single select.
protected boolean	m_bDSSupportMirroring Flag to know whether the Crawler's DS supports mirroring.
protected boolean	m_bImportOnlyNewLinks Flag to know whether this Crawler is configured to import only new links.
boolean	m_bRefreshExistingCards Determines whether refresh settings should be applied to previously imported cards
protected boolean	m_bSupportsACLImport Flag to know whether this Crawler supports ACL import or no.
int	m_nDeletionCards Number of deleted cards in the deletion history.
int	m_nRejectionCards Number of deleted cards in the rejection history.
protected IXPPropertyBag	m_pbStartLocation Crawler Start Location Property Bag
java.lang.String	m_sDataSourceName Name of the Data Source
static java.lang.String	QS_CRAWLEREDITOR_DATASOURCE_ID Query String param: data source ID

Fields inherited from class com.plumtree.portaluiinfrastructure.editor.ObjEditorModel

EDITOR_CLASSID_UNKNOWN, EDITOR_FOLDERID_UNKNOWN, EDITOR_OBJECTID_UNKNOWN, EDITOR_QS_BOL_QS_FORCESAVEINFOLDER, EDITOR_QS_INT_CLASS_ID, EDITOR_QS_INT_QS_FOLDER_ID, EDITOR_QS_INT_QS_OBJECT_ID, m_bDisableDescription, m_bDisableSecurity, m_bForceSavedInSuppliedFolder, m_bIsSysAdmin, m_nClassID, m_nFolderID, m_nFolderType, m_nObjectID, m_ptObject, m_Session, m_sFolderName, OBJECT_NAME_TRUNCATE

Fields inherited from class com.plumtree.uiinfrastructure.editor.EditorModel

isReadAccessAvailable, m_asOwner, m_bCloseOnDone, m_bDeleteOnCancel, m_bEnableApplyButton, m_bEnableCancelButton, m_bHideLeftNav, m_bIsEditorReadOnly, m_bUserHasAccessToEditor, m_nEditorType

Constructor Summary

CrawlerModel()

Method Summary

void	ChangeMirroringStatus() Performs the change mirroring action
void	ClearDeletionHistory() Clears the crawler's deletion history.
void	ClearRejectionHistory() Clears the crawler's rejection history.
void	DoTaskAfterStore() Code executed after the object is stored.
void	DoTaskBeforeStore() Code executed before the object is stored.
void	DoTaskOnComeBackFromSubEditor() This method will be called when you come back to the main Editor from a sub Editor.
void	DoTaskOnStartEditor(XPHashtable _htFormData) Code executed when the Editor is starting.
boolean	GetApplyExisting() Tells whether previously imported cards should be updated for new refresh settings.
int	GetCrawlerSettings() Returns crawler settings
java.lang.String	GetCrawlerTag()
java.lang.String	GetDataSourceName() Returns the Data Source name.
int	GetDocMapSectionCount() Returns the number of Sections to display on the Document Type Map page.
boolean	GetImportOnlyNewLinks() Returns the flag m_bImportOnlyNewLinks.
protected abstract java.lang.String	GetMainDPName() Returns the name of the MainDP display page.
IXPPropertyBag	GetRuntimeConfiguration() Get the runtime configuration property bag
boolean	GetSupportMirroring() Tells whether the Crawler's DS supports mirroring or no.
boolean	GetSupportsACLImport() Tells whether the Crawler supports ACL import.
int	GetTaxSettings() Returns taxonomist settings
IPTQueryResult	GetUnmappedExternalDomains() Returns the Query Result of the Unmapped External Domains filtered by the Data Source of this Crawler.
protected abstract void	InitProviderPropertyBag(IXPPropertyBag _pbStartLocation) Initializes the Crawler property bag.
protected void	InitPTObject(XPHashtable _htFormData) Retrieves the DS ID and initializes the Crawler.
void	RaiseError(java.lang.String strError) Helper method to raise an error
void	RaiseError(java.lang.String strError, java.lang.String strExtended) Helper method to raise an error
int	SaveMainDP(XPHashtable _htFormData) Helper methods to save the settings on MainDP.
int	SavePage(java.lang.String _sPageName, XPHashtable _htFormData) Calls the right save function according to the page name passed in argument.
void	StartCardSecurity() Helper method to start the security page.
void	StartContentLanguage() Helper method to init the Content language common section.
void	StartImportSettings() Helper method to init the Importing Docs view
void	StartLinkSettings() Helper method to init the Link Settings page.
void	StartSelectFolder() Helper method to start the Select Folder List.
protected void	StoreAdvSettings() Helper method to store the advanced settings.
void	StoreContentLanguage() Helper method to get back the data from the content language page and set them on the crawler.
protected void	StoreDestFolders() Helper method to store the destination folders.
void	StoreLinkSettings() Helper method to get back the data from the link settings page and set them on the crawler.

Methods inherited from class com.plumtree.portaluiinfrastructure.editor.ObjEditorModel

CheckEditorAccess, CheckEditorAccessAndStart, CheckFolderType, DisableSecurity, Finish, ForceSaveInFolder, GetClassID, GetFolderID, GetFolderName, GetIsSysAdmin, GetMigrationStatus, GetObject, GetObjectDescription, GetObjectID, GetObjectName, GetParentFolderPath, GetPTSession, Init, InitIsSysAdminFlag, IsDescriptionDisabled, IsMigrationApproved, SaveMigrationStatus, SetDisableDescription, SetEditorToReadOnly, SetMemberVariablesFromQS, SetMigrationStatus, StartKeywords, StartLocNamesList, StartMigrationHistory, StartObjectProp, StartSecurityList, StoreObject

Methods inherited from class com.plumtree.uiinfrastructure.editor.EditorModel

Cancel, CleanupAllData, CleanupTempData, Create, DoTaskOnChangePage, GetAccessToEditorPriviledges, GetCloseOnDone, GetCurrentRepostAction, GetDeleteOnCancel, GetEditorType, GetEnableApplyButton, GetEnableCancelButton, GetHideLeftNav, GetIsEditorReadOnly, GetName, GetRedirectAfterFinish, GetUserHasAccessToEditor, SetCloseOnDone, SetDeleteOnCancel, SetEditorType, SetEnableApplyButton, SetHideLeftNav, SetPageStatus, SetUserHasAccessToEditor

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.plumtree.portaluiinfrastructure.editor.IObjEditorModelRO

GetClassID, GetObject, GetObjectDescription, GetObjectID, GetObjectName, GetParentFolderPath, GetPTSession

Methods inherited from interface com.plumtree.uiinfrastructure.editor.IEditorModelRO

GetEditorType, GetEnableApplyButton, GetEnableCancelButton, GetHideLeftNav, GetIsEditorReadOnly

Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IMVCObject

GetName

Field Detail

QS_CRAWLEREDITOR_DATASOURCE_ID

public static final java.lang.String QS_CRAWLEREDITOR_DATASOURCE_ID

Query String param: data source ID

See Also:

Constant Field Values

m_bDisplayMirroringAlert

public boolean m_bDisplayMirroringAlert

When the mirroring check box is checked, the destination folders selection becomes single select. That's why we need to notify the User.

m_bRefreshExistingCards

public boolean m_bRefreshExistingCards

Determines whether refresh settings should be applied to previously imported cards

m_nDeletionCards

public int m_nDeletionCards

Number of deleted cards in the deletion history.

m_nRejectionCards

public int m_nRejectionCards

Number of deleted cards in the rejection history.

m_sDataSourceName

public java.lang.String m_sDataSourceName

Name of the Data Source

m_pbStartLocation

protected IXPPropertyBag m_pbStartLocation

Crawler Start Location Property Bag

crawlerRuntimeConfig

protected IXPPropertyBag crawlerRuntimeConfig

Crawler Runtime Configuration Property Bag Put infomation about the number of threads, etc. here

m_bDSSupportMirroring

protected boolean m_bDSSupportMirroring

Flag to know whether the Crawler's DS supports mirroring.

m_bSupportsACLImport

protected boolean m_bSupportsACLImport

Flag to know whether this Crawler supports ACL import or no.

m_bImportOnlyNewLinks

protected boolean m_bImportOnlyNewLinks

Flag to know whether this Crawler is configured to import only new links.

Constructor Detail

CrawlerModel

public CrawlerModel()

Method Detail

ClearDeletionHistory

public void ClearDeletionHistory()

Clears the crawler's deletion history.

GetDataSourceName

public java.lang.String GetDataSourceName()

Returns the Data Source name.

ClearRejectionHistory

public void ClearRejectionHistory()

Clears the crawler's rejection history.

ChangeMirroringStatus

public void ChangeMirroringStatus()

Performs the change mirroring action

DoTaskAfterStore

public void DoTaskAfterStore()

Code executed after the object is stored.

Overrides:

DoTaskAfterStore in class EditorModel

DoTaskBeforeStore

public void DoTaskBeforeStore()

Code executed before the object is stored.

Overrides:

DoTaskBeforeStore in class EditorModel

DoTaskOnComeBackFromSubEditor

public void DoTaskOnComeBackFromSubEditor()

This method will be called when you come back to the main Editor from a sub Editor.

Overrides:

DoTaskOnComeBackFromSubEditor in class ObjEditorModel

DoTaskOnStartEditor

public void DoTaskOnStartEditor(XPHashtable _htFormData)

Code executed when the Editor is starting.

Overrides:

DoTaskOnStartEditor in class EditorModel

Parameters:

_htFormData -

GetCrawlerSettings

public int GetCrawlerSettings()

Returns crawler settings

Specified by:

GetCrawlerSettings in interface ICrawlerModelRO

Returns:

int

See Also:

GetCrawlerSettings()

GetDocMapSectionCount

public int GetDocMapSectionCount()

Returns the number of Sections to display on the Document Type Map page.

Specified by:

GetDocMapSectionCount in interface ICrawlerModelRO

Returns:

int

See Also:

GetDocMapSectionCount()

GetImportOnlyNewLinks

public boolean GetImportOnlyNewLinks()

Returns the flag m_bImportOnlyNewLinks.

Specified by:

GetImportOnlyNewLinks in interface ICrawlerModelRO

Returns:

boolean

See Also:

GetImportOnlyNewLinks()

GetSupportMirroring

public boolean GetSupportMirroring()

Tells whether the Crawler's DS supports mirroring or no.

Specified by:

GetSupportMirroring in interface ICrawlerModelRO

Returns:

boolean

See Also:

GetSupportMirroring()

GetSupportsACLImport

public boolean GetSupportsACLImport()

Tells whether the Crawler supports ACL import.

Specified by:

GetSupportsACLImport in interface ICrawlerModelRO

Returns:

boolean

See Also:

GetSupportsACLImport()

GetTaxSettings

public int GetTaxSettings()

Returns taxonomist settings

Specified by:

GetTaxSettings in interface ICrawlerModelRO

Returns:

int

See Also:

GetTaxSettings()

SaveMainDP

public int SaveMainDP(XPHashtable _htFormData)

Helper methods to save the settings on MainDP.

Parameters:

_htFormData -

Returns:

int Page status for server side validation

SavePage

public int SavePage(java.lang.String _sPageName,
                    XPHashtable _htFormData)

Calls the right save function according to the page name passed in argument.

Specified by:

SavePage in interface IRepostModel

Overrides:

SavePage in class ObjEditorModel

Parameters:

_sPageName -

_htFormData -

Returns:

int Page status for server side validation

StartCardSecurity

public void StartCardSecurity()

Helper method to start the security page.

StartContentLanguage

public void StartContentLanguage()

Helper method to init the Content language common section.

StartImportSettings

public void StartImportSettings()

Helper method to init the Importing Docs view

StartLinkSettings

public void StartLinkSettings()

Helper method to init the Link Settings page.

StartSelectFolder

public void StartSelectFolder()

Helper method to start the Select Folder List.

StoreContentLanguage

public void StoreContentLanguage()

Helper method to get back the data from the content language page and set them on the crawler.

StoreLinkSettings

public void StoreLinkSettings()

Helper method to get back the data from the link settings page and set them on the crawler.

GetMainDPName

protected abstract java.lang.String GetMainDPName()

Returns the name of the MainDP display page.

Returns:

String

InitPTObject

protected void InitPTObject(XPHashtable _htFormData)

Retrieves the DS ID and initializes the Crawler.

Overrides:

InitPTObject in class ObjEditorModel

Parameters:

_htFormData -

InitProviderPropertyBag

protected abstract void InitProviderPropertyBag(IXPPropertyBag _pbStartLocation)

Initializes the Crawler property bag. (Called in create mode ONLY)

Parameters:

_pbStartLocation -

StoreAdvSettings

protected void StoreAdvSettings()

Helper method to store the advanced settings.

StoreDestFolders

protected void StoreDestFolders()

Helper method to store the destination folders.

GetUnmappedExternalDomains

public IPTQueryResult GetUnmappedExternalDomains()

Returns the Query Result of the Unmapped External Domains filtered by the Data Source of this Crawler.

Specified by:

GetUnmappedExternalDomains in interface ICrawlerModelRO

Returns:

IPTQueryResult

See Also:

GetUnmappedExternalDomains()

GetCrawlerTag

public java.lang.String GetCrawlerTag()

Specified by:

GetCrawlerTag in interface ICrawlerModelRO

See Also:

GetCrawlerTag()

GetApplyExisting

public boolean GetApplyExisting()

Tells whether previously imported cards should be updated for new refresh settings.

Specified by:

GetApplyExisting in interface ICrawlerModelRO

Returns:

boolean

See Also:

GetApplyExisting()

GetRuntimeConfiguration

public IXPPropertyBag GetRuntimeConfiguration()

Get the runtime configuration property bag

Specified by:

GetRuntimeConfiguration in interface ICrawlerModelRO

See Also:

ICrawlerModelRO.GetRuntimeConfiguration()

RaiseError

public void RaiseError(java.lang.String strError,
                       java.lang.String strExtended)

Helper method to raise an error

Parameters:

strError - - Error message

strError - - Extended error message

RaiseError

public void RaiseError(java.lang.String strError)

Helper method to raise an error

Parameters:

strError - - Error message