A C D E F G I J M N O P R S T U W

A

add(Result.Field) - Method in class org.appng.search.json.Result.Fields

addEntry(String, String, String) - Method in class org.appng.search.indexer.IndexConfig

addField(IndexableField) - Method in class org.appng.search.indexer.SimpleDocument

addObserver(Observer<? super Document>) - Method in class org.appng.search.indexer.SimpleDocument

C

cleanSearchWord(String) - Method in class org.appng.search.searcher.GermanSearchTermProcessor

remove special characters from the search term.

CLEAR_INDEX - Static variable in class org.appng.search.indexer.DocumentIndexer

compareTo(Document) - Method in class org.appng.search.indexer.SimpleDocument

compareTo(Result) - Method in class org.appng.search.json.Result

ConfigEntry(String, String, String) - Constructor for class org.appng.search.indexer.IndexConfig.ConfigEntry

count(Serializable) - Method in interface org.appng.search.json.FilterItem.DataCounter

D

DateAdapter - Class in org.appng.search.searcher

A XmlAdapter responsible for adapting a String to a Date and vice versa.

DateAdapter(DateFormat) - Constructor for class org.appng.search.searcher.DateAdapter

DATEFORMAT - Static variable in class org.appng.search.indexer.SimpleDocument

DEFAULT_DATE_PATTERN - Static variable in class org.appng.search.searcher.SearchFormatter

DEFAULT_PAGE - Static variable in class org.appng.search.searcher.SearchFormatter

DEFAULT_PAGE_PARAM - Static variable in class org.appng.search.searcher.SearchFormatter

DEFAULT_PAGE_SIZE_PARAM - Static variable in class org.appng.search.searcher.SearchFormatter

DEFAULT_PAGESIZE - Static variable in class org.appng.search.searcher.SearchFormatter

DEFAULT_QUERY_PARAM - Static variable in class org.appng.search.searcher.SearchFormatter

DocumentIndexer - Class in org.appng.search.indexer

A Consumer of DocumentEvents produced by a DocumentProducer.

DocumentIndexer(int, File, Long) - Constructor for class org.appng.search.indexer.DocumentIndexer

Creates a new DocumentIndexer.

DocumentIndexer(File, Long) - Constructor for class org.appng.search.indexer.DocumentIndexer

DocumentProvider - Interface in org.appng.search

When building the global Lucene index for a Site, every DocumentProvider provided by the site's Applications is able to add/remove some Documents to be indexed.

doIndex(Site, String) - Method in class org.appng.search.indexer.GlobalIndexer

doSearch(Environment, Site, Application, Directory, String, String, String[], Analyzer, String, Map<String, String>) - Method in class org.appng.search.searcher.StandardSearcher

doSearch(Environment, Site, Application, Directory, String, String, String[], Analyzer, String, Map<String, String>) - Method in interface org.appng.search.SearchProvider

Performs the actual search

E

extract(Document, int, float) - Static method in class org.appng.search.indexer.SimpleDocument

F

Field() - Constructor for class org.appng.search.json.Result.Field

Field(String, String) - Constructor for class org.appng.search.json.Result.Field

Fields() - Constructor for class org.appng.search.json.Result.Fields

FileSystemProvider - Class in org.appng.search.indexer

FileSystemProvider(IndexConfig, List<String>, long, String, File, Collection<? extends File>) - Constructor for class org.appng.search.indexer.FileSystemProvider

Filter - Class in org.appng.search.json

Filter() - Constructor for class org.appng.search.json.Filter

FilterConfig - Class in org.appng.search.json

FilterConfig() - Constructor for class org.appng.search.json.FilterConfig

FilterData - Class in org.appng.search.json

FilterData() - Constructor for class org.appng.search.json.FilterData

FilterData(String, boolean, String, Integer) - Constructor for class org.appng.search.json.FilterData

FilterItem - Class in org.appng.search.json

FilterItem() - Constructor for class org.appng.search.json.FilterItem

FilterItem.DataCounter - Interface in org.appng.search.json

FORMAT_JSON - Static variable in class org.appng.search.searcher.SearchFormatter

FORMAT_XML - Static variable in class org.appng.search.searcher.SearchFormatter

fromDocument(Document) - Static method in class org.appng.search.json.Result

G

GermanSearchTermProcessor - Class in org.appng.search.searcher

This class is used to replace special characters from the search terms.

GermanSearchTermProcessor() - Constructor for class org.appng.search.searcher.GermanSearchTermProcessor

GermanSearchTermProcessor(Map<String, String>) - Constructor for class org.appng.search.searcher.GermanSearchTermProcessor

getAdditionalFields() - Method in class org.appng.search.indexer.SimpleDocument

getAnalyzer() - Method in class org.appng.search.indexer.IndexConfig.ConfigEntry

getAnalyzer() - Method in class org.appng.search.searcher.GermanSearchTermProcessor

getAnalyzer() - Method in interface org.appng.search.searcher.SearchTermProcessor

Gets the Analyzer used while processing

getAnalyzerClass() - Method in class org.appng.search.indexer.IndexConfig.ConfigEntry

getConfig() - Method in class org.appng.search.json.FilterItem

getContent() - Method in class org.appng.search.indexer.SimpleDocument

getData() - Method in class org.appng.search.json.FilterItem

getData() - Method in class org.appng.search.json.Part

getData() - Method in class org.appng.search.json.Results

getDate() - Method in class org.appng.search.indexer.SimpleDocument

getDate() - Method in class org.appng.search.json.Result

getDateFormat() - Method in class org.appng.search.searcher.SearchFormatter

getDefaultAnalyzer() - Static method in class org.appng.search.Search

getDefaultAnalyzerClass() - Static method in class org.appng.search.Search

getDescription() - Method in class org.appng.search.indexer.SimpleDocument

getDocId() - Method in class org.appng.search.indexer.SimpleDocument

getDocumentProducers(Site, Application) - Method in interface org.appng.search.DocumentProvider

Returns some DocumentProducers to take into account when building the Site's global lucene index.

getDocumentProducers(Site, Application) - Method in class org.appng.search.indexer.FileSystemProvider

getEntry(String) - Method in class org.appng.search.indexer.IndexConfig

getField(String) - Method in class org.appng.search.indexer.SimpleDocument

getFieldList() - Method in class org.appng.search.json.Result

getFields() - Method in class org.appng.search.json.Result.Fields

getFields() - Method in class org.appng.search.json.Result

getFilter() - Method in class org.appng.search.json.Search

getFilterItem(String, String, String, Iterable<T>, Collection<ID>, FilterItem.DataCounter) - Static method in class org.appng.search.json.FilterItem

getFolder() - Method in class org.appng.search.indexer.IndexConfig.ConfigEntry

getFolders() - Method in class org.appng.search.indexer.IndexConfig

getFormat() - Method in class org.appng.search.searcher.SearchFormatter

getFragment() - Method in class org.appng.search.indexer.SimpleDocument

getFragment() - Method in class org.appng.search.json.Result

getId() - Method in class org.appng.search.indexer.SimpleDocument

getImage() - Method in class org.appng.search.indexer.SimpleDocument

getImage() - Method in class org.appng.search.json.Result

getInstance(String, String) - Static method in class org.appng.search.indexer.IndexConfig

Parses a given String to an IndexConfig, using the pipe '|' for separating folders.
format:
<folder>;<language>;<analyzer-class>|
Example:
/de;de-DE;GermanAnalyzer|/en;en-US;org.apache.lucene.analysis.en.EnglishAnalyzer|/assets;de-DE;GermanAnalyzer

getInstance(List<String>, String) - Static method in class org.appng.search.indexer.IndexConfig

Parses a list of strings to an IndexConfig.

getItemsCount() - Method in class org.appng.search.json.FilterConfig

getLabel() - Method in class org.appng.search.json.FilterConfig

getLabel() - Method in class org.appng.search.json.FilterData

getLanguage() - Method in class org.appng.search.indexer.IndexConfig.ConfigEntry

getLanguage() - Method in class org.appng.search.indexer.SimpleDocument

getLanguage() - Method in class org.appng.search.json.Result

getLayout() - Method in class org.appng.search.json.Results

getLink() - Method in class org.appng.search.json.Result

getMaxItems() - Method in interface org.appng.search.json.FilterItem.DataCounter

getName() - Method in class org.appng.search.indexer.SimpleDocument

getName() - Method in class org.appng.search.json.FilterConfig

getName() - Method in class org.appng.search.json.Result.Field

getNumberFromField(Document, String, List<IndexableField>) - Static method in class org.appng.search.indexer.SimpleDocument

getNumberOfElements() - Method in class org.appng.search.json.Page

getNumberOfPages() - Method in class org.appng.search.json.Page

getObservable() - Method in class org.appng.search.indexer.SimpleDocument

getOpenMode() - Method in class org.appng.search.indexer.IndexConfig

getPage() - Method in class org.appng.search.json.Page

getPage() - Method in class org.appng.search.searcher.SearchFormatter

getPageParam() - Method in class org.appng.search.json.Page

getPageParamName() - Method in class org.appng.search.searcher.SearchFormatter

getPageSize() - Method in class org.appng.search.json.Page

getPageSize() - Method in class org.appng.search.searcher.SearchFormatter

getPageSizeParam() - Method in class org.appng.search.json.Page

getPageSizeParamName() - Method in class org.appng.search.searcher.SearchFormatter

getPagination() - Method in class org.appng.search.json.Results

getPart() - Method in class org.appng.search.json.Part

getParts() - Method in class org.appng.search.searcher.SearchFormatter

getPath() - Method in class org.appng.search.indexer.SimpleDocument

getQuery(String[], String, Analyzer, String, String[]) - Method in class org.appng.search.searcher.StandardSearcher

getQueryParam() - Method in class org.appng.search.searcher.SearchFormatter

getQueryParamName() - Method in class org.appng.search.searcher.SearchFormatter

getResults() - Method in class org.appng.search.json.Search

getResultsCount() - Method in class org.appng.search.json.FilterData

getScore() - Method in class org.appng.search.indexer.SimpleDocument

getScore() - Method in class org.appng.search.json.Result

getSearch() - Method in class org.appng.search.json.SearchFilter

getSearchTerm(String) - Method in class org.appng.search.searcher.GermanSearchTermProcessor

getSearchTerm(String) - Method in interface org.appng.search.searcher.SearchTermProcessor

Processes the search term.

getSearchTerm(String, String) - Method in class org.appng.search.searcher.StandardSearcher

getSortedDocs() - Method in class org.appng.search.searcher.SearchFormatter

getTagPrefix() - Method in class org.appng.search.indexer.IndexConfig

getText() - Method in class org.appng.search.json.Result

getTime() - Method in class org.appng.search.json.Results

getTime() - Method in class org.appng.search.searcher.SearchFormatter

getTitle() - Method in class org.appng.search.json.Result

getType() - Method in class org.appng.search.indexer.SimpleDocument

getType() - Method in class org.appng.search.json.FilterConfig

getType() - Method in class org.appng.search.json.Result

getValue() - Method in class org.appng.search.json.FilterData

getValue() - Method in class org.appng.search.json.Result.Field

getVisibleItemsCount() - Method in class org.appng.search.json.FilterConfig

getXslStylesheet() - Method in class org.appng.search.searcher.SearchFormatter

GlobalIndexer - Class in org.appng.search.indexer

Builds the global lucene search index for a Site.

GlobalIndexer(Consumer<DocumentEvent, DocumentProducer>) - Constructor for class org.appng.search.indexer.GlobalIndexer

I

IndexConfig - Class in org.appng.search.indexer

A IndexConfig is used to provide different index configurations for different folders.

IndexConfig(String) - Constructor for class org.appng.search.indexer.IndexConfig

Creates a new ParseTags using the given tag-prefix (usually appNG).

IndexConfig.ConfigEntry - Class in org.appng.search.indexer

A ConfigEntry provides informations about how to index a certion folder, which includes the name of the folder itself, the language-code for the contents of this folder, and the name of the Lucene Analyzer to use.

indexDirectory(int) - Method in class org.appng.search.indexer.FileSystemProvider

Performs the actual indexing.

isActive() - Method in class org.appng.search.json.FilterData

isDoXsl() - Method in class org.appng.search.searcher.SearchFormatter

isPretty() - Method in class org.appng.search.searcher.SearchFormatter

isUseParts() - Method in class org.appng.search.searcher.SearchFormatter

isVisible() - Method in class org.appng.search.json.FilterConfig

J

Json - Class in org.appng.search.json

Helper class to convert an object to it's JSON representation and vice versa.

Json(DateFormat, boolean) - Constructor for class org.appng.search.json.Json

Json() - Constructor for class org.appng.search.json.Json

M

marshal(Date) - Method in class org.appng.search.searcher.DateAdapter

MAX_HITS - Static variable in interface org.appng.search.SearchProvider

N

notifyObservers(Observable.Event) - Method in class org.appng.search.indexer.SimpleDocument

O

org.appng.search - package org.appng.search

Base package for the search component

org.appng.search.indexer - package org.appng.search.indexer

Types used to provide indexing functionality

org.appng.search.json - package org.appng.search.json

Model classes representing the results of a search

org.appng.search.searcher - package org.appng.search.searcher

Types used to provide search functionality

P

Page - Class in org.appng.search.json

Page() - Constructor for class org.appng.search.json.Page

paginate(List<Result>) - Method in class org.appng.search.searcher.SearchFormatter

parse(InputStream) - Method in class org.appng.search.indexer.ParseTags

Parses the given InputStream and returns a Map containing the name of a field as a key and a StringBuilder (the text content of the <appNG:searchable>-tag) as the value.

parse(File) - Method in class org.appng.search.indexer.ParseTags

ParseTags - Class in org.appng.search.indexer

Utility-class used to parse <appNG:searchable>-tags from JSP-files.

ParseTags(String) - Constructor for class org.appng.search.indexer.ParseTags

Creates a new ParseTags using the given tag-prefix (usually appNG).

Part - Class in org.appng.search.json

Part(String) - Constructor for class org.appng.search.json.Part

processXML(Writer, List<Result>, DateFormat) - Method in class org.appng.search.searcher.SearchFormatter

R

removeObserver(Observer<? super Document>) - Method in class org.appng.search.indexer.SimpleDocument

removeUmlauts(String) - Method in class org.appng.search.searcher.GermanSearchTermProcessor

replace German special alphabet.

Result - Class in org.appng.search.json

Result() - Constructor for class org.appng.search.json.Result

Result.Field - Class in org.appng.search.json

Result.Fields - Class in org.appng.search.json

Results - Class in org.appng.search.json

Results() - Constructor for class org.appng.search.json.Results

run() - Method in class org.appng.search.indexer.DocumentIndexer

Starts this DocumentIndexer, running forever (until interrupted).

S

Search<T extends Filter> - Class in org.appng.search.json

Search() - Constructor for class org.appng.search.json.Search

Search - Class in org.appng.search

Search() - Constructor for class org.appng.search.Search

SearchFilter - Class in org.appng.search.json

SearchFilter() - Constructor for class org.appng.search.json.SearchFilter

SearchFilter(FilterItem) - Constructor for class org.appng.search.json.SearchFilter

SearchFormatter - Class in org.appng.search.searcher

A SearchFormatter is responsible for formatting the Results of a search, which are grouped into several Parts.

SearchFormatter(DocumentBuilderFactory, TransformerFactory) - Constructor for class org.appng.search.searcher.SearchFormatter

SearchProvider - Interface in org.appng.search

When performing a global search within a Site, every Application of the site is checked for SearchProviders offering some Documents.

SearchTermProcessor - Interface in org.appng.search.searcher

Interface for processing a search term, i.e.

setActive(boolean) - Method in class org.appng.search.json.FilterData

setConfig(FilterConfig) - Method in class org.appng.search.json.FilterItem

setContent(String) - Method in class org.appng.search.indexer.SimpleDocument

setData(List<FilterData>) - Method in class org.appng.search.json.FilterItem

setData(List<Result>) - Method in class org.appng.search.json.Part

setData(List<Result>) - Method in class org.appng.search.json.Results

setDate(Date) - Method in class org.appng.search.indexer.SimpleDocument

setDate(Date) - Method in class org.appng.search.json.Result

setDateFormat(String) - Method in class org.appng.search.searcher.SearchFormatter

setDescription(String) - Method in class org.appng.search.indexer.SimpleDocument

setDocId(int) - Method in class org.appng.search.indexer.SimpleDocument

setDoXsl(boolean) - Method in class org.appng.search.searcher.SearchFormatter

setFields(List<Result.Field>) - Method in class org.appng.search.json.Result.Fields

setFields(Result.Fields) - Method in class org.appng.search.json.Result

setFilter(T) - Method in class org.appng.search.json.Search

setFormat(String) - Method in class org.appng.search.searcher.SearchFormatter

setFragment(String) - Method in class org.appng.search.indexer.SimpleDocument

setFragment(String, Analyzer, Query, String) - Method in class org.appng.search.indexer.SimpleDocument

setFragment(SimpleDocument, String, Analyzer, Query, String) - Static method in class org.appng.search.indexer.SimpleDocument

setFragment(String) - Method in class org.appng.search.json.Result

setId(String) - Method in class org.appng.search.indexer.SimpleDocument

setImage(String) - Method in class org.appng.search.indexer.SimpleDocument

setImage(String) - Method in class org.appng.search.json.Result

setItemsCount(Integer) - Method in class org.appng.search.json.FilterConfig

setLabel(String) - Method in class org.appng.search.json.FilterConfig

setLabel(String) - Method in class org.appng.search.json.FilterData

setLanguage(String) - Method in class org.appng.search.indexer.SimpleDocument

setLanguage(String) - Method in class org.appng.search.json.Result

setLayout(FilterItem) - Method in class org.appng.search.json.Results

setLink(String) - Method in class org.appng.search.json.Result

setName(String) - Method in class org.appng.search.indexer.SimpleDocument

setName(String) - Method in class org.appng.search.json.FilterConfig

setName(String) - Method in class org.appng.search.json.Result.Field

setNumberOfElements(long) - Method in class org.appng.search.json.Page

setNumberOfPages(int) - Method in class org.appng.search.json.Page

setObservable(Observable<Document>) - Method in class org.appng.search.indexer.SimpleDocument

setOpenMode(IndexWriterConfig.OpenMode) - Method in class org.appng.search.indexer.IndexConfig

setPage(int) - Method in class org.appng.search.json.Page

setPage(int) - Method in class org.appng.search.searcher.SearchFormatter

setPageParam(String) - Method in class org.appng.search.json.Page

setPageParamName(String) - Method in class org.appng.search.searcher.SearchFormatter

setPageSize(int) - Method in class org.appng.search.json.Page

setPageSize(int) - Method in class org.appng.search.searcher.SearchFormatter

setPageSizeParam(String) - Method in class org.appng.search.json.Page

setPageSizeParamName(String) - Method in class org.appng.search.searcher.SearchFormatter

setPagination(Page) - Method in class org.appng.search.json.Results

setPart(String) - Method in class org.appng.search.json.Part

setParts(List<Part>) - Method in class org.appng.search.searcher.SearchFormatter

setPath(String) - Method in class org.appng.search.indexer.SimpleDocument

setPretty(boolean) - Method in class org.appng.search.searcher.SearchFormatter

setQueryParam(String) - Method in class org.appng.search.searcher.SearchFormatter

setQueryParamName(String) - Method in class org.appng.search.searcher.SearchFormatter

setResults(Results) - Method in class org.appng.search.json.Search

setResultsCount(Integer) - Method in class org.appng.search.json.FilterData

setScore(float) - Method in class org.appng.search.indexer.SimpleDocument

setScore(float) - Method in class org.appng.search.json.Result

setSearch(FilterItem) - Method in class org.appng.search.json.SearchFilter

setText(String) - Method in class org.appng.search.json.Result

setTime(long) - Method in class org.appng.search.json.Results

setTime(long) - Method in class org.appng.search.searcher.SearchFormatter

setTitle(String) - Method in class org.appng.search.json.Result

setType(String) - Method in class org.appng.search.indexer.SimpleDocument

setType(String) - Method in class org.appng.search.json.FilterConfig

setType(String) - Method in class org.appng.search.json.Result

setUseParts(boolean) - Method in class org.appng.search.searcher.SearchFormatter

setValue(String) - Method in class org.appng.search.json.FilterData

setValue(String) - Method in class org.appng.search.json.Result.Field

setVisible(boolean) - Method in class org.appng.search.json.FilterConfig

setVisibleItemsCount(Integer) - Method in class org.appng.search.json.FilterConfig

setXslStylesheet(File) - Method in class org.appng.search.searcher.SearchFormatter

SimpleDocument - Class in org.appng.search.indexer

A basic Document-implementation, suitable for most cases.

SimpleDocument() - Constructor for class org.appng.search.indexer.SimpleDocument

SimpleDocument(float) - Constructor for class org.appng.search.indexer.SimpleDocument

StandardSearcher - Class in org.appng.search.searcher

StandardSearcher() - Constructor for class org.appng.search.searcher.StandardSearcher

T

toJson(Object, JsonInclude.Include) - Method in class org.appng.search.json.Json

toJson(Object) - Method in class org.appng.search.json.Json

toObject(String, Class<T>, Module...) - Method in class org.appng.search.json.Json

U

unmarshal(String) - Method in class org.appng.search.searcher.DateAdapter

W

write(OutputStream) - Method in class org.appng.search.searcher.SearchFormatter

write(Writer) - Method in class org.appng.search.searcher.SearchFormatter

A C D E F G I J M N O P R S T U W