net.sf.mmm.search.indexer.base.config

Class SearchIndexerDataLocationBean

java.lang.Object

net.sf.mmm.search.indexer.base.config.SearchIndexerDataLocationBean

All Implemented Interfaces:

SearchIndexerDataLocation, JaxbObject

public class SearchIndexerDataLocationBean
extends Object
implements SearchIndexerDataLocation, JaxbObject

This is the implementation of SearchIndexerDataLocation as JAXB-ready Java-Bean.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	absoluteUris
private String	baseUri
private String	encoding
private FilterRuleChain<String>	filter
private String	localtionUri
private SearchIndexerSourceBean	source
private String	updateStrategyVariant
private StringTransformerChain	uriTransformer

Fields inherited from interface net.sf.mmm.search.indexer.api.config.SearchIndexerDataLocation

UPDATE_STRATEGY_VCS_VARIANT_BAZAAR, UPDATE_STRATEGY_VCS_VARIANT_CVS, UPDATE_STRATEGY_VCS_VARIANT_GIT, UPDATE_STRATEGY_VCS_VARIANT_MERCURIAL, UPDATE_STRATEGY_VCS_VARIANT_PERFORCE, UPDATE_STRATEGY_VCS_VARIANT_SVN, UPDATE_STRATEGY_VCS_VARIANT_TFS, UPDATE_STRATEGY_VCS_VARIANT_VSS

Constructor Summary

Constructors

Constructor and Description
SearchIndexerDataLocationBean() The constructor.

Method Summary

Modifier and Type	Method and Description
void	afterUnmarshal(Unmarshaller unmarshaller, Object parent) This method is automatically invoked by JAXB after un-marshaling this bean.
String	getBaseUri() This method gets the base-URI used to build the search-entry-URI for the location itself.
String	getEncoding() This method gets the encoding of the resources in this location.
FilterRuleChain<String>	getFilter() This method gets the Filter that decides which resource-URIs should be accepted for indexing.
String	getLocationUri() This method gets the location (typically an URL) with the data that should be part of the search index.
SearchIndexerSource	getSource() This method gets the Source associated with this directory.
String	getUpdateStrategyVariant() This method determines the optional variant of the update-strategy.
StringTransformerChain	getUriTransformer() This method gets the Transformer used to convert the (relative) URI of a resource to the indexed URI.
boolean	isAbsoluteUris() This method determines if search-entry-URIs should be set to the absolute location.
void	setAbsoluteUris(boolean absoluteUris)
void	setBaseUri(String baseUri)
void	setEncoding(String encoding)
void	setFilter(FilterRuleChain<String> filter)
void	setLocaltionUri(String path)
void	setSource(SearchIndexerSourceBean source)
void	setUpdateStrategyVariant(String updateStrategyVariant) This method sets the update-strategy-variant.
void	setUriTransformer(StringTransformerChain uriTransformer)

Methods inherited from class java.lang.Object

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

Field Detail

localtionUri

private String localtionUri

See Also:

getLocationUri()

source

private transient SearchIndexerSourceBean source

See Also:

getSource()

encoding

private String encoding

See Also:

getEncoding()

baseUri

private String baseUri

See Also:

getBaseUri()

absoluteUris

private boolean absoluteUris

See Also:

isAbsoluteUris()

filter

private FilterRuleChain<String> filter

See Also:

getFilter()

uriTransformer

private StringTransformerChain uriTransformer

See Also:

getUriTransformer()

updateStrategyVariant

private String updateStrategyVariant

See Also:

getUpdateStrategyVariant()

Constructor Detail

SearchIndexerDataLocationBean

public SearchIndexerDataLocationBean()

The constructor.

Method Detail

getLocationUri

public String getLocationUri()

This method gets the location (typically an URL) with the data that should be part of the search index. This location will be indexed recursively according to the filter.

• File-URLs should point to a directory to index (e.g. "file:///data/documents")
• HTTP(S)-URLs should point to a web-site to index via a crawler.

Specified by:

getLocationUri in interface SearchIndexerDataLocation

Returns:

the URI to index.

setLocaltionUri

public void setLocaltionUri(String path)

Parameters:

path - is the path to set

getSource

public SearchIndexerSource getSource()

This method gets the Source associated with this directory.

Specified by:

getSource in interface SearchIndexerDataLocation

Returns:

the SearchIndexerSource.

setSource

public void setSource(SearchIndexerSourceBean source)

Parameters:

source - is the source to set

getEncoding

public String getEncoding()

This method gets the encoding of the resources in this location. If the encoding is specified (e.g. via content formats as XML or HTML) that specific encoding is used. - otherwise the default encoding returned by this method is used. Therefore you should typically not choose an UTF encoding.

Specified by:

getEncoding in interface SearchIndexerDataLocation

Returns:

the encoding used as fallback or null for automatic unicode detection.

setEncoding

public void setEncoding(String encoding)

Parameters:

encoding - is the encoding to set

getBaseUri

public String getBaseUri()

This method gets the base-URI used to build the search-entry-URI for the location itself.
This will typically be the empty string. However if you want to index multiple locations of the same source you can use this attribute. E.g. when source is "svn" and you have one location that points to where you checked out "trunk/documents" of a subversion repository then the base-URI may be "documents". Analog you may also have another location with a base-URI of "development/code". Therefore SearchSource.getUrlPrefix() may be something like "http://svn.foo.bar/trunk/".

Specified by:

getBaseUri in interface SearchIndexerDataLocation

Returns:

the base-URI for this location. If the base-URI is NOT empty, it should end with a slash ("/").

setBaseUri

public void setBaseUri(String baseUri)

Parameters:

baseUri - is the baseUri to set

isAbsoluteUris

public boolean isAbsoluteUris()

This method determines if search-entry-URIs should be set to the absolute location. This can make sense if you want to index a web-site via an HTTP-location but also some related sites linked from there. In all other cases this should be false.

Specified by:

isAbsoluteUris in interface SearchIndexerDataLocation

Returns:

true if the absolute URIs should be stored in the search-index, false if the URIs should be relative to location with respect to the base-URI.

See Also:

SearchIndexerDataLocation.getBaseUri()

setAbsoluteUris

public void setAbsoluteUris(boolean absoluteUris)

Parameters:

absoluteUris - is the absoluteUris to set

getFilter

public FilterRuleChain<String> getFilter()

Description copied from interface: SearchIndexerDataLocation

This method gets the Filter that decides which resource-URIs should be accepted for indexing.
ATTENTION:
This filter is applied to files AND folders. If a folder is NOT accepted then this entire folder is NOT crawled any further and therefore its children are NOT indexed. All files that are crawled and accepted will be added to the search-index.

Specified by:

getFilter in interface SearchIndexerDataLocation

Returns:

the filter

setFilter

public void setFilter(FilterRuleChain<String> filter)

Parameters:

filter - is the filter to set

getUriTransformer

public StringTransformerChain getUriTransformer()

This method gets the Transformer used to convert the (relative) URI of a resource to the indexed URI. By default the transformer will keep the URI untouched. However the Transformer can rewrite the URI if it differs from the path to access the file online. E.g. the relevant files in the data directory of a twiki/foswiki installation have the extension .txt while their URLs do NOT contain this extension.

Specified by:

getUriTransformer in interface SearchIndexerDataLocation

Returns:

the URI-Transformer.

setUriTransformer

public void setUriTransformer(StringTransformerChain uriTransformer)

Parameters:

uriTransformer - is the uriTransformer to set

getUpdateStrategyVariant

public String getUpdateStrategyVariant()

This method determines the optional variant of the update-strategy.
E.g. if the update-strategy of the according SearchIndexerSource is SearchIndexerSource.UPDATE_STRATEGY_VCS, then this variant can determine the actual VCS to use (see UPDATE_STRATEGY_VCS_VARIANT_* constants like SearchIndexerDataLocation.UPDATE_STRATEGY_VCS_VARIANT_SVN). However if not set ( null) the VCS will be auto detected (by looking for folders like .svn, .hg, .git, etc.)

Specified by:

getUpdateStrategyVariant in interface SearchIndexerDataLocation

Returns:

the variant for the update-strategy or null for default.

setUpdateStrategyVariant

public void setUpdateStrategyVariant(String updateStrategyVariant)

This method sets the update-strategy-variant.

Parameters:

updateStrategyVariant - is the new value to set.

afterUnmarshal

public void afterUnmarshal(Unmarshaller unmarshaller,
                           Object parent)

This method is automatically invoked by JAXB after un-marshaling this bean. It allows to link the parent object.

Specified by:

afterUnmarshal in interface JaxbObject

Parameters:

unmarshaller - is the Unmarshaller.

parent - is the java-object representing the parent node in XML.