|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LuceneSearchEnginePolicyFilter
This class allow developers to put hooks to change lucene search engine mechanism behaviour. To get more information about the current request in hooks, the method Channel#getCurrentJcmsContext() must be called.
Field Summary | |
---|---|
static String |
REVISION
|
Method Summary | |
---|---|
void |
filterCategoryDocument(org.apache.lucene.document.Document doc,
Category cat,
String lang)
This method is called when the given Category is being index in the given language, just before writing the Document into the index. |
void |
filterFileDocument(org.apache.lucene.document.Document doc,
File file)
This method is called when the given File is being index, just before writing the Document into the index. |
void |
filterPublicationDocument(org.apache.lucene.document.Document doc,
Publication pub,
String lang)
This method is called when the given Publication is being index in the given language, just before writing the Document into the index. |
org.apache.lucene.analysis.Analyzer |
getAnalyzer(String lang,
boolean isIndexing,
org.apache.lucene.analysis.Analyzer analyzer)
Return the Lucene Analyzer to use for a given language. |
float |
getCategoryBoost(Category cat,
String lang,
float jcms)
Return the boost that should be apply to the lucene Document
that will be created for the given Category . |
float |
getFieldBoost(Category cat,
String lang,
String fieldName,
String fieldValue,
float jcms)
Return the boost that should be apply to the lucene Field
that will be created for the given Category 's field. |
float |
getFieldBoost(Publication pub,
String lang,
String fieldName,
String fieldValue,
float jcms)
Return the boost that should be apply to the lucene Field
that will be created for the given Publication 's field. |
String[] |
getLanguageStopWords(String lang,
String[] jcms)
|
HashSet<String> |
getLanguageStopWordsSet(String lang,
HashSet<String> jcms)
|
float |
getPublicationBoost(Publication pub,
String lang,
float jcms)
Return the boost that should be apply to the lucene Document
that will be created for the given Publication . |
Methods inherited from interface java.lang.Comparable |
---|
compareTo |
Methods inherited from interface com.jalios.jcms.plugin.PluginComponent |
---|
init |
Field Detail |
---|
static final String REVISION
Method Detail |
---|
String[] getLanguageStopWords(String lang, String[] jcms)
HashSet<String> getLanguageStopWordsSet(String lang, HashSet<String> jcms)
org.apache.lucene.analysis.Analyzer getAnalyzer(String lang, boolean isIndexing, org.apache.lucene.analysis.Analyzer analyzer)
lang
- the ISO-639 code of the language analyzedisIndexing
- true if the returned anallyzer is to be used
for indexing, false in any other case (e.g. during search etc..)
You may want to use this parameter to change the behaviour of your
analyzer during those case (for example, synonym analyzer must
generate synonyms only when indexing, not during search).analyzer
- the internal Analyzer, created by JCMS, that should be
returned if you do not want to return a customize analyzer
float getPublicationBoost(Publication pub, String lang, float jcms)
Document
that will be created for the given Publication
. Document
boost factor implicitly sets the starting boost of
all fields to the specified value, Field-specific boosts are multiplied by
the starting value, giving the final value of the field boost factor.
pub
- the Publication indexedlang
- the indexed languagejcms
- the jcms internal boost
float getFieldBoost(Publication pub, String lang, String fieldName, String fieldValue, float jcms)
Field
that will be created for the given Publication
's field. Publication
's field of type array (int[]
,
long[]
, String[]
, etc) this method will only be
called once. As we are creating appendable lucene Field
in those
case, calling the boost only for the first creationg prevent boost to multiplied
as many times as there elements in the array.
pub
- the publication indexedlang
- the indexed languagefieldName
- the indexed field's namefieldValue
- the String value of the indexed field)jcms
- the jcms internal boost
float getCategoryBoost(Category cat, String lang, float jcms)
Document
that will be created for the given Category
.
cat
- the Category indexedlang
- the indexed languagejcms
- the jcms internal boost
float getFieldBoost(Category cat, String lang, String fieldName, String fieldValue, float jcms)
Field
that will be created for the given Category
's field. Category
's field of type array (int[]
,
long[]
, String[]
, etc) this method will only be
called once. As we are creating appendable lucene Field
in those
case, calling the boost only for the first creationg prevent boost to multiplied
as many times as there elements in the array (Synonyms being a good examples).
cat
- the Category indexedlang
- the indexed languagefieldName
- the indexed field's namefieldValue
- the String value of the indexed field)jcms
- the jcms internal boost
void filterPublicationDocument(org.apache.lucene.document.Document doc, Publication pub, String lang)
doc
- the lucene Document that was created by JCMS search enginepub
- the Publication
being indexedlang
- the indexed languageLucenePublicationSearchEngine
void filterCategoryDocument(org.apache.lucene.document.Document doc, Category cat, String lang)
doc
- the lucene Document that was created by JCMS search enginecat
- the Category
being indexedlang
- the indexed languageLuceneCategorySearchEngine
void filterFileDocument(org.apache.lucene.document.Document doc, File file)
doc
- the lucene Document that was created by JCMS search enginefile
- the File
being indexedLuceneFileSearchEngine
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |