oracle.ecsf.meta
Class SearchableObject

java.lang.Object
  MetaTreeNodeImpl
      oracle.ecsf.meta.SearchableObject

All Implemented Interfaces:

java.io.Serializable

public class SearchableObject
extends MetaTreeNodeImpl
implements java.io.Serializable

The SearchableObject represents search related meta data for a business object.

Field Summary

protected static java.util.logging.Logger

logger

Constructor Summary

SearchableObject()

SearchableObject(java.lang.String name)
Constructs searchable from a name

Method Summary

IndexableDocument	createIndexableDocument() Creates an indexable mDocument instance.
java.lang.String	getApplId() get the application id
java.lang.String	getBody() Gets body definition per developers of the searchable object.
oracle.jbo.ExprEval	getBodyExpr() Expression built from body groovy expression.
java.lang.String	getCrawlableFactoryName() Returns the name of Crawlable Factory used for this object.
SearchResultActionDef	getDefaultActionDef() Returns default action definition object.
oracle.jbo.ExprEval	getDefaultActionExpr() Returns Expression Evaluator for default action;
java.lang.String	getDefaultActionTitle() Returns the default aciton title in groovy expression.
java.lang.String	getDeployedVersion() Returns the deployed version of this object being deployed into SES instance.
java.lang.String	getDisplayName() Gets display name.
AbstractDocumentDefinition	getDocument() Returns root mDocument.
java.lang.String	getDrivingTableAlias() Returns driving table alias for this object.
java.lang.String	getDrivingTableName() Returns driving table name for this object.
long	getECSFComponentId() Get the remote ECSF server id for global search
SearchPluginDef	getECSFPlugIn() Returns plugin definition for this object.
FacetDef[]	getFacetDefs() A convenient method to get Facet Defitions associated to this searchable object.
java.lang.String	getId() Returns mId of this object.
java.lang.String	getKeywords() Returns keywords definition for this searchable object.
java.lang.String	getKeyWords() Deprecated. use getKeywords instead
oracle.jbo.ExprEval	getKeywordsExpr() Returns an evaluated expression of Groovy.
java.lang.String	getLanguageFieldName() Returns langauge field name.
java.util.Date	getLastTimeCrawled() Returns time last this searchable object is crawled.
java.lang.String	getPlugInName() Returns plugin name for this object.
java.util.Hashtable<java.lang.String,java.lang.String>	getProperties() Get the properties.
java.lang.String	getProperty(java.lang.String key) Get the property.
long	getScheduleId() This method is not for external consumption
java.lang.String	getSchemaName() Gets Schema name.
SearchResultActionDef[]	getSearchActions() Returns an array of search actions assigned to this object.
SearchEngine	getSearchEngine() Returns a search engine implementation for this object.
long	getSearchEngineInstanceId()
java.lang.String	getSearchEngineReference() Returns search engine reference for this searchable object.
java.lang.Object	getSearchPlugin() Gets a service bean.
java.lang.String	getTitle() Returns title definition for this object.
oracle.jbo.ExprEval	getTitleExpression() Returns parsed expression
java.lang.String	getVersion() Returns mVersion of this object.
boolean	isActive()
boolean	isDeployed()
void	setActive(boolean isActive)
void	setApplId(java.lang.String applId) set the application id
void	setBody(java.lang.String body) Sets body definition.
void	setDeployed(boolean isDeployed)
void	setDeployedVersion(java.lang.String deployedVersion) Sets the mVersion of this object being deployed to SES instance.
void	setDisplayName(java.lang.String displayName) Sets display name
void	setDocument(AbstractDocumentDefinition doc) Sets root mDocument for this object.
void	setDrivingSchemaObject(java.lang.String schemaName, java.lang.String drivingTableName, java.lang.String drivingTableAlias) Sets schema and driving table name for this object.
void	setECSFComponentId(long componentId) Set the remote ECSF server id for global search
void	setECSFPlugIn(SearchPluginDef plugIn) Sets security plugin definition.
void	setId(java.lang.String id) Sets id of this object.
void	setKeywords(java.lang.String keywords) Sets keywords defintion.
void	setLanguageFieldName(java.lang.String languageFieldName) Sets language field for this object.
void	setLastTimeCrawled(java.util.Date lastTimeCrawled) Sets last time when this object crawled but dont have to propagate to DB (because it is already there).
void	setLastTimeCrawled(java.util.Date lastTimeCrawled, SearchContext ctx) Sets last time when this object crawled.
void	setPlugInName(java.lang.String plugInName) Sets plugin name.
void	setProperty(java.lang.String key, java.lang.String value) Set the property.
void	setScheduleId(long id) Sets indexScehduleId of this object.
void	setSearchActions(SearchResultActionDef[] actions) Sets action definitions to this object.
void	setSearchEngineInstanceId(long seiId)
void	setSearchEngineReference(java.lang.String searchEngineReference) Sets the reference value for this definition in a search engine.
void	setTitle(java.lang.String title) Sets title definition in groovy expression.
void	setVersion(java.lang.String version) Sets mVersion for this object.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static java.util.logging.Logger logger

Constructor Detail

SearchableObject

public SearchableObject()

SearchableObject

public SearchableObject(java.lang.String name)

Constructs searchable from a name

Parameters:

name -

Method Detail

getSchemaName

public java.lang.String getSchemaName()

Gets Schema name.

setDisplayName

public void setDisplayName(java.lang.String displayName)

Sets display name

getDisplayName

public java.lang.String getDisplayName()

Gets display name.

Returns:

displayName.

setDocument

public void setDocument(AbstractDocumentDefinition doc)

Sets root mDocument for this object.

Parameters:

doc - definition.

getDocument

public AbstractDocumentDefinition getDocument()

Returns root mDocument.

Returns:

Document definition.

setSearchEngineInstanceId

public void setSearchEngineInstanceId(long seiId)

getSearchEngineInstanceId

public long getSearchEngineInstanceId()

getSearchPlugin

public java.lang.Object getSearchPlugin()
                                 throws SearchSecurityException

Gets a service bean.

Throws:

SearchSecurityException

setLastTimeCrawled

public void setLastTimeCrawled(java.util.Date lastTimeCrawled)

Sets last time when this object crawled but dont have to propagate to DB (because it is already there).

setLastTimeCrawled

public void setLastTimeCrawled(java.util.Date lastTimeCrawled,
                               SearchContext ctx)
                        throws SearchException

Sets last time when this object crawled. This should be persisted in to transactional database.

Throws:

SearchException

getLastTimeCrawled

public java.util.Date getLastTimeCrawled()

Returns time last this searchable object is crawled.

setSearchEngineReference

public void setSearchEngineReference(java.lang.String searchEngineReference)

Sets the reference value for this definition in a search engine.

Parameters:

searchEngineReference -

getSearchEngineReference

public java.lang.String getSearchEngineReference()

Returns search engine reference for this searchable object.

Returns:

search engine reference.

setPlugInName

public void setPlugInName(java.lang.String plugInName)

Sets plugin name. This must be a valid Java class name.

Parameters:

plugInName - class name of the plugin for this searchable object.

getPlugInName

public java.lang.String getPlugInName()

Returns plugin name for this object.

Returns:

name of plugin name.

getDrivingTableAlias

public java.lang.String getDrivingTableAlias()

Returns driving table alias for this object.

Returns:

driving table alias.

getDrivingTableName

public java.lang.String getDrivingTableName()

Returns driving table name for this object.

Returns:

driving table name.

setDrivingSchemaObject

public void setDrivingSchemaObject(java.lang.String schemaName,
                                   java.lang.String drivingTableName,
                                   java.lang.String drivingTableAlias)

Sets schema and driving table name for this object. It must be in the format of schema.name.

Parameters:

schemaName -

createIndexableDocument

public IndexableDocument createIndexableDocument()

Creates an indexable mDocument instance. This method delegates the creation logic to the search engine.

getSearchEngine

public SearchEngine getSearchEngine()

Returns a search engine implementation for this object.

Returns:

an search engine implementation.

setId

public void setId(java.lang.String id)

Sets id of this object. This is used internally when it is synched with database.

Parameters:

id - the new id for this object.

getId

public java.lang.String getId()

Returns mId of this object. If null, meaning the object has not been loaded into database.

Returns:

id of this object.

setScheduleId

public void setScheduleId(long id)

Sets indexScehduleId of this object. This method is not for external consumption

Parameters:

id - the index schedule id for this object.

getScheduleId

public long getScheduleId()

This method is not for external consumption

Returns:

id of the index scehdule this object associated to.

setActive

public void setActive(boolean isActive)

isActive

public boolean isActive()

setDeployed

public void setDeployed(boolean isDeployed)

isDeployed

public boolean isDeployed()

setLanguageFieldName

public void setLanguageFieldName(java.lang.String languageFieldName)

Sets language field for this object. This value is set via wizard.

Parameters:

languageFieldName - field name as language column.

getLanguageFieldName

public java.lang.String getLanguageFieldName()

Returns langauge field name.

Returns:

field name for language for this object.

setVersion

public void setVersion(java.lang.String version)

Sets mVersion for this object. This is the mVersion of VO object. This is only used internally.

Parameters:

version - . The mVersion of this object.

getVersion

public java.lang.String getVersion()

Returns mVersion of this object.

Returns:

mVersion of the SVO.

setTitle

public void setTitle(java.lang.String title)

Sets title definition in groovy expression.

Parameters:

title - the groovy exression used as title for documents genertated for this searchable object.

getTitle

public java.lang.String getTitle()

Returns title definition for this object. It is a groovy expression.

Returns:

the title definition.

getTitleExpression

public oracle.jbo.ExprEval getTitleExpression()

Returns parsed expression

Returns:

setBody

public void setBody(java.lang.String body)

Sets body definition. it should be a groovy expression.

Parameters:

body - the groovy expresion used as body for the searchable object.

getBody

public java.lang.String getBody()

Gets body definition per developers of the searchable object. This should be a groovy expression.

Returns:

the body definition.

getBodyExpr

public oracle.jbo.ExprEval getBodyExpr()

Expression built from body groovy expression. For internal use only.

Returns:

the parsed expression .

setKeywords

public void setKeywords(java.lang.String keywords)

Sets keywords defintion. This should be an groovy expression

Parameters:

keywords - the groovy expression used as keywords

getKeyWords

public java.lang.String getKeyWords()

Deprecated. use getKeywords instead

Returns:

keywords definition.

getKeywords

public java.lang.String getKeywords()

Returns keywords definition for this searchable object. It should be a groovy expression.

Returns:

keywords defnition in groovy expression.

getKeywordsExpr

public oracle.jbo.ExprEval getKeywordsExpr()

Returns an evaluated expression of Groovy. It is for internal use only.

Returns:

an evaluated expression of keywords expression.

setECSFPlugIn

public void setECSFPlugIn(SearchPluginDef plugIn)

Sets security plugin definition. This is for internal use only.

Parameters:

plugIn - @SearchPluginDef is an internal class wraps plugin definition for a searchable object.

getECSFPlugIn

public SearchPluginDef getECSFPlugIn()

Returns plugin definition for this object.

Returns:

SearchPluginDef that contains definition of the plugin.

setSearchActions

public void setSearchActions(SearchResultActionDef[] actions)

Sets action definitions to this object. Action definitions can be stored by a @Configuration. This is the method to access it.

Parameters:

actions - an array of action defnitions.

getSearchActions

public SearchResultActionDef[] getSearchActions()

Returns an array of search actions assigned to this object.

Returns:

an array of search action definitions.

getDefaultActionDef

public SearchResultActionDef getDefaultActionDef()

Returns default action definition object.

Returns:

default action definiiton.

getDefaultActionExpr

public oracle.jbo.ExprEval getDefaultActionExpr()

Returns Expression Evaluator for default action;

Returns:

Expression Evaluator.

getDefaultActionTitle

public java.lang.String getDefaultActionTitle()

Returns the default aciton title in groovy expression. This is internally by ECSF.

Returns:

the groovy expression assigned as default action title.

getFacetDefs

public FacetDef[] getFacetDefs()

A convenient method to get Facet Defitions associated to this searchable object.

Returns:

an array of facet definitions.

setDeployedVersion

public void setDeployedVersion(java.lang.String deployedVersion)

Sets the mVersion of this object being deployed to SES instance. This is used by deployManager only.

Parameters:

deployedVersion - version string of the deployed searchable object.

getDeployedVersion

public java.lang.String getDeployedVersion()

Returns the deployed version of this object being deployed into SES instance.

Returns:

mVersion string.

getCrawlableFactoryName

public java.lang.String getCrawlableFactoryName()

Returns the name of Crawlable Factory used for this object.

setApplId

public void setApplId(java.lang.String applId)

set the application id

Parameters:

applId - an application id string

getApplId

public java.lang.String getApplId()

get the application id

Returns:

an application id string

setECSFComponentId

public void setECSFComponentId(long componentId)

Set the remote ECSF server id for global search

Parameters:

componentId - the new component Id for this object.

getECSFComponentId

public long getECSFComponentId()

Get the remote ECSF server id for global search

Returns:

component id this objectd belongs to.

getProperty

public java.lang.String getProperty(java.lang.String key)

Get the property.

Parameters:

key - Property key

Returns:

Property value

setProperty

public void setProperty(java.lang.String key,
                        java.lang.String value)

Set the property.

Parameters:

key - Property key

value - Property value

getProperties

public java.util.Hashtable<java.lang.String,java.lang.String> getProperties()

Get the properties.

Returns:

Properties