com.arsdigita.search
Class SearchConfig

java.lang.Object
  com.arsdigita.util.parameter.AbstractParameterContext
      com.arsdigita.runtime.AbstractConfig
          com.arsdigita.search.SearchConfig

All Implemented Interfaces:

ParameterContext

public final class SearchConfig

extends AbstractConfig

Stores the configuration record for the search service

Field Summary

Fields inherited from class com.arsdigita.runtime.AbstractConfig

versionId

Constructor Summary

SearchConfig()

Method Summary

boolean	allowsContent(ContentType content) Determines if the content type represented by the specified bitmask is supported.
boolean	allowsRawContent() Determines if raw binary content is supported
boolean	allowsTextContent() Determines if plain text content is supported
boolean	allowsXMLContent() Determines if xml content is supported
ContentType[]	getContent() Returns the bitmask for allowed content types.
String	getIndexer() Returns the current active indexer type key
IndexerType	getIndexerType() Returns the current active indexer type
boolean	getLazyUpdates() Returns the lazy update flag.
DocumentObserver	getObserver() Returns the current document update observer
Integer	getRawContentWeight() The relative given to raw content when ranking search results.
Integer	getXMLContentWeight() The relative given to XML content when ranking search results.
boolean	isIntermediaEnabled() Convenience method for determining if intermedia is currently enabled
boolean	isLuceneEnabled() Convenience method for determining if lucene is currently enabled

Methods inherited from class com.arsdigita.runtime.AbstractConfig

load, load, load, require

Methods inherited from class com.arsdigita.util.parameter.AbstractParameterContext

get, get, getParameters, load, load, loadInfo, register, save, set, validate, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchConfig

public SearchConfig()

Method Detail

getIndexerType

public IndexerType getIndexerType()

Returns the current active indexer type

getIndexer

public String getIndexer()

Returns the current active indexer type key

See Also:

isIntermediaEnabled(), isLuceneEnabled()

isIntermediaEnabled

public boolean isIntermediaEnabled()

Convenience method for determining if intermedia is currently enabled

Returns:

true if intermedia is active, false otherwise

See Also:

getIndexer()

isLuceneEnabled

public boolean isLuceneEnabled()

Convenience method for determining if lucene is currently enabled

Returns:

true if intermedia is active, false otherwise

See Also:

getIndexer()

getContent

public ContentType[] getContent()

Returns the bitmask for allowed content types. The bits in the mask correspond to the XXX constants defined in the ContentType class.

Returns:

content bit mask

See Also:

ContentType.RAW, ContentType.XML, ContentType.TEXT

allowsRawContent

public boolean allowsRawContent()

Determines if raw binary content is supported

Returns:

true if raw content is supported

See Also:

allowsTextContent(), allowsXMLContent()

allowsTextContent

public boolean allowsTextContent()

Determines if plain text content is supported

Returns:

true if text content is supported

See Also:

allowsRawContent(), allowsXMLContent()

allowsXMLContent

public boolean allowsXMLContent()

Determines if xml content is supported

Returns:

true if xml content is supported

See Also:

allowsTextContent(), allowsRawContent()

allowsContent

public boolean allowsContent(ContentType content)

Determines if the content type represented by the specified bitmask is supported.

Returns:

true if the bitmask requested is supported

See Also:

allowsXMLContent(), allowsTextContent(), allowsRawContent()

getObserver

public DocumentObserver getObserver()

Returns the current document update observer

Returns:

the document observer, or null if none is configured.

getLazyUpdates

public boolean getLazyUpdates()

Returns the lazy update flag. If this is set to true, then the search index will only be updated at the end of a transaction.

Returns:

true if lazy updates are turned on

getXMLContentWeight

public Integer getXMLContentWeight()

The relative given to XML content when ranking search results. Only used by the interMedia query engine.

getRawContentWeight

public Integer getRawContentWeight()

The relative given to raw content when ranking search results. Only used by the interMedia query engine.