|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jalios.jcms.policy.AbstractPolicyFilter
com.jalios.jcms.policy.BasicLuceneSearchEnginePolicyFilter
public class BasicLuceneSearchEnginePolicyFilter
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
|
Fields inherited from class com.jalios.jcms.policy.AbstractPolicyFilter |
---|
order |
Constructor Summary | |
---|---|
BasicLuceneSearchEnginePolicyFilter()
|
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 |
filterMemberDocument(org.apache.lucene.document.Document doc,
Member mbr)
This method is called when the given Member 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 analyser)
Return the Lucene Analyzer to use for a given language. |
HashSet<String> |
getLanguageStopWordsSet(String lang,
HashSet<String> jcms)
Retrieves stop words of the specified language. |
boolean |
init(Plugin plugin)
Initialize the component with the given plugin configuration |
Methods inherited from class com.jalios.jcms.policy.AbstractPolicyFilter |
---|
compareTo, equals, getOrder, setOrder |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface java.lang.Comparable |
---|
compareTo |
Field Detail |
---|
public static final String REVISION
Constructor Detail |
---|
public BasicLuceneSearchEnginePolicyFilter()
Method Detail |
---|
public boolean init(Plugin plugin)
PluginComponent
init
in interface PluginComponent
plugin
- the calling plugin
PluginComponent.init(Plugin)
public HashSet<String> getLanguageStopWordsSet(String lang, HashSet<String> jcms)
LuceneSearchEnginePolicyFilter
getLanguageStopWordsSet
in interface LuceneSearchEnginePolicyFilter
lang
- a ISO-639 language codejcms
- the default Set stop word configured in JCMS
LuceneSearchEnginePolicy.getLanguageStopWordsSet(String)
public org.apache.lucene.analysis.Analyzer getAnalyzer(String lang, boolean isIndexing, org.apache.lucene.analysis.Analyzer analyser)
LuceneSearchEnginePolicyFilter
getAnalyzer
in interface LuceneSearchEnginePolicyFilter
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).analyser
- the internal Analyzer, created by JCMS, that should be
returned if you do not want to return a customize analyzer
LuceneSearchEnginePolicyFilter.getAnalyzer(String, boolean, Analyzer)
public void filterPublicationDocument(org.apache.lucene.document.Document doc, Publication pub, String lang)
LuceneSearchEnginePolicyFilter
filterPublicationDocument
in interface LuceneSearchEnginePolicyFilter
doc
- the lucene Document that was created by JCMS search enginepub
- the Publication
being indexedlang
- the indexed languageLuceneSearchEnginePolicyFilter.filterPublicationDocument(Document, Publication, String)
public void filterCategoryDocument(org.apache.lucene.document.Document doc, Category cat, String lang)
LuceneSearchEnginePolicyFilter
filterCategoryDocument
in interface LuceneSearchEnginePolicyFilter
doc
- the lucene Document that was created by JCMS search enginecat
- the Category
being indexedlang
- the indexed languageLuceneSearchEnginePolicyFilter.filterCategoryDocument(Document, Category, String)
public void filterFileDocument(org.apache.lucene.document.Document doc, File file)
LuceneSearchEnginePolicyFilter
filterFileDocument
in interface LuceneSearchEnginePolicyFilter
doc
- the lucene Document that was created by JCMS search enginefile
- the File
being indexedLuceneSearchEnginePolicyFilter.filterFileDocument(Document, java.io.File)
public void filterMemberDocument(org.apache.lucene.document.Document doc, Member mbr)
LuceneSearchEnginePolicyFilter
filterMemberDocument
in interface LuceneSearchEnginePolicyFilter
doc
- the lucene Document that was created by JCMS search enginembr
- the Member
being indexedLuceneSearchEnginePolicyFilter.filterMemberDocument(Document, Member)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |