de.innovationgate.wga.common.beans

Class LuceneIndexFileRule

java.lang.Object

de.innovationgate.wga.common.beans.LuceneIndexFileRule

public class LuceneIndexFileRule
extends java.lang.Object

Represents a lucene rule to index file attachments

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FILEPATTERN_WILDCARD Wildcard for file name patterns
static int	FILESIZELIMIT_INDEX_ALL File size limit representing that all files are indexed
static int	FILESIZELIMIT_INDEX_NONE File size limit representing that no files are indexed

Constructor Summary

Constructors

Constructor and Description
LuceneIndexFileRule()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addDefaultRule(org.dom4j.Element lucene) adds the default rule to the lucene.itemrules element
boolean	equals(java.lang.Object obj)
float	getBoost() returns the boost value of this rule
static LuceneIndexFileRule	getDefaultRule() Returns the default rule for newly created databases
java.lang.String	getFilePattern() Returns the file pattern
java.lang.String	getFilePatternClearWildcard() Returns the file pattern name without eventually trailing text after the wildcard
int	getFileSizeLimit() Returns the size limit of bytes for indexing files via this rule.
static java.util.List	getRules(org.dom4j.Element lucene) get rules from configfile element lucene
static java.util.List<LuceneIndexFileRule>	getRules(java.util.List<de.innovationgate.wga.config.LuceneIndexFileRule> rules) get rules from configbean list
boolean	hasWildcard() Determines if the rule file pattern has a wildcard
boolean	isDefaultRule() Determines if this rule is a default rule that will apply to all files not taken by other rules
boolean	isIncludedInAllContent() Returns if the index information of this file should be used for unspecific searches where no item to search is defined.
static void	saveRules(org.dom4j.Element lucene, java.util.List rules) Saves rules to lucene configuration in wga.xml
void	setBoost(float boost) sets the boost value for this rule
void	setFilePattern(java.lang.String filePattern) Sets the file pattern.
void	setFileSizeLimit(int fileSizeLimit) Sets the size limit of bytes for indexing files via this rule.
void	setIncludedInAllContent(boolean includedInAllContent) Sets if the index information of this file should be used for unspecific searches where no item to search if defined.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FILEPATTERN_WILDCARD

public static final java.lang.String FILEPATTERN_WILDCARD

Wildcard for file name patterns

See Also:

Constant Field Values

FILESIZELIMIT_INDEX_NONE

public static final int FILESIZELIMIT_INDEX_NONE

File size limit representing that no files are indexed

See Also:

Constant Field Values

FILESIZELIMIT_INDEX_ALL

public static final int FILESIZELIMIT_INDEX_ALL

File size limit representing that all files are indexed

See Also:

Constant Field Values

Constructor Detail

LuceneIndexFileRule

public LuceneIndexFileRule()

Method Detail

getRules

public static java.util.List getRules(org.dom4j.Element lucene)

get rules from configfile element lucene

Parameters:

lucene - configfile element

Returns:

list LuceneIndexFileRules

getRules

public static java.util.List<LuceneIndexFileRule> getRules(java.util.List<de.innovationgate.wga.config.LuceneIndexFileRule> rules)

get rules from configbean list

Returns:

list LuceneIndexItemRules

saveRules

public static void saveRules(org.dom4j.Element lucene,
             java.util.List rules)

Saves rules to lucene configuration in wga.xml

Parameters:

lucene - The lucene configuration element

rules - List of LuceneIndexFileRule objects to be saved

getDefaultRule

public static LuceneIndexFileRule getDefaultRule()

Returns the default rule for newly created databases

addDefaultRule

public static void addDefaultRule(org.dom4j.Element lucene)

adds the default rule to the lucene.itemrules element

Parameters:

lucene - luceneElement

hasWildcard

public boolean hasWildcard()

Determines if the rule file pattern has a wildcard

isDefaultRule

public boolean isDefaultRule()

Determines if this rule is a default rule that will apply to all files not taken by other rules

getFilePatternClearWildcard

public java.lang.String getFilePatternClearWildcard()

Returns the file pattern name without eventually trailing text after the wildcard

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getFilePattern

public java.lang.String getFilePattern()

Returns the file pattern

setFilePattern

public void setFilePattern(java.lang.String filePattern)

Sets the file pattern. The pattern may end with a wildcard character FILEPATTERN_WILDCARD.

Parameters:

filePattern -

getFileSizeLimit

public int getFileSizeLimit()

Returns the size limit of bytes for indexing files via this rule. This rule will only apply to files up to this limit. Note special values FILESIZELIMIT_INDEX_ALL and FILESIZELIMIT_INDEX_NONE for this setting.

setFileSizeLimit

public void setFileSizeLimit(int fileSizeLimit)

Sets the size limit of bytes for indexing files via this rule. This rule will only apply to files up to this limit. Note special values FILESIZELIMIT_INDEX_ALL and FILESIZELIMIT_INDEX_NONE for this setting.

Parameters:

fileSizeLimit -

isIncludedInAllContent

public boolean isIncludedInAllContent()

Returns if the index information of this file should be used for unspecific searches where no item to search is defined.

setIncludedInAllContent

public void setIncludedInAllContent(boolean includedInAllContent)

Sets if the index information of this file should be used for unspecific searches where no item to search if defined. If this is false the index information will only be used for searches against item "allattachments"

Parameters:

includedInAllContent -

getBoost

public float getBoost()

returns the boost value of this rule

setBoost

public void setBoost(float boost)

sets the boost value for this rule

Parameters:

boost -

Throws:

java.lang.IllegalArgumentException - if boost is <=0