Index (product-documentation 15.24.0-SNAPSHOT API)

A B C D F G I L M N O P R S V
All Classes All Packages

A

APPLICATION_JSON_TEXT - Static variable in interface com.funnelback.filter.api.DocumentType: Deprecated.
asContentType() - Method in interface com.funnelback.filter.api.DocumentType: Gets the document type as a Content-Type header value.
ATTEMPT_FILTER - com.funnelback.filter.api.filters.PreFilterCheck: Returned when the pre filter check decides that an attempt to filter the document should be made.

B

BytesDocument - Interface in com.funnelback.filter.api.documents: A raw byte document.
BytesDocumentFilter - Interface in com.funnelback.filter.api.filters: Filters a document where the content is converted to a byte[].

C

canFilter(NoContentDocument, FilterContext) - Method in interface com.funnelback.filter.api.filters.BytesDocumentFilter: Checks if the document can be filtered.
canFilter(NoContentDocument, FilterContext) - Method in interface com.funnelback.filter.api.filters.StringDocumentFilter: Checks if the document can be filtered.
cloneWithContent(DocumentType, Optional<Charset>, byte[]) - Method in interface com.funnelback.filter.api.documents.BytesDocument: Creates a clone of the document with the given content.
cloneWithDocumentType(DocumentType) - Method in interface com.funnelback.filter.api.documents.FilterableDocument: Creates a clone of the document with the given document type.
cloneWithMetadata(ListMultimap<String, String>) - Method in interface com.funnelback.filter.api.documents.BytesDocument: Gets a clone of the document with the given metadata.
cloneWithMetadata(ListMultimap<String, String>) - Method in interface com.funnelback.filter.api.documents.FilterableDocument: Gets a clone of the document with the given metadata.
cloneWithMetadata(ListMultimap<String, String>) - Method in interface com.funnelback.filter.api.documents.StringDocument
cloneWithStringContent(DocumentType, String) - Method in interface com.funnelback.filter.api.documents.StringDocument: Creates a clone of the document with the given content and document type.
cloneWithURI(URI) - Method in interface com.funnelback.filter.api.documents.BytesDocument: Gets a clone of the document with a different URI.
cloneWithURI(URI) - Method in interface com.funnelback.filter.api.documents.FilterableDocument: Gets a clone of the document with a different URI.
cloneWithURI(URI) - Method in interface com.funnelback.filter.api.documents.StringDocument
com.funnelback.filter.api - package com.funnelback.filter.api: This holds the public API which clients are expected to use for filtering.
com.funnelback.filter.api.documents - package com.funnelback.filter.api.documents
com.funnelback.filter.api.filters - package com.funnelback.filter.api.filters
com.funnelback.filter.api.mock - package com.funnelback.filter.api.mock
contentAsInputStream() - Method in interface com.funnelback.filter.api.documents.BytesDocument: Gets the contents of the document as an input stream.

D

delete() - Static method in class com.funnelback.filter.api.FilterResult: Returned by a filter when it wants to delete the given document.
DocumentType - Interface in com.funnelback.filter.api: Holds the information describing the type of the document.

F

filter(FilterableDocument, FilterContext) - Method in interface com.funnelback.filter.api.filters.BytesDocumentFilter: Filter method responsible for calling #canFilter(FilterableDocument, FilterContext) and BytesDocumentFilter.filterAsBytesDocument(BytesDocument, FilterContext)
filter(FilterableDocument, FilterContext) - Method in interface com.funnelback.filter.api.filters.Filter: Filter a document.
filter(FilterableDocument, FilterContext) - Method in interface com.funnelback.filter.api.filters.StringDocumentFilter: Filter method responsible for calling #canFilter(FilterableDocument, FilterContext) and StringDocumentFilter.filterAsStringDocument(StringDocument, FilterContext)
Filter - Interface in com.funnelback.filter.api.filters: Filters a document.
FilterableDocument - Interface in com.funnelback.filter.api.documents: A Document which can be filtered by the filter framework.
filterAsBytesDocument(BytesDocument, FilterContext) - Method in interface com.funnelback.filter.api.filters.BytesDocumentFilter: Filters the BytesDocument
filterAsStringDocument(StringDocument, FilterContext) - Method in interface com.funnelback.filter.api.filters.StringDocumentFilter: Filters the StringDocument
FilterContext - Interface in com.funnelback.filter.api: An immutable context supplied to the filters.
FilterException - Exception in com.funnelback.filter.api.filters: Thrown when an error occurs during filtering of a document and filtering of that document should not proceed.
FilterException(FilterableDocument, String) - Constructor for exception com.funnelback.filter.api.filters.FilterException
FilterException(FilterableDocument, String, Throwable) - Constructor for exception com.funnelback.filter.api.filters.FilterException
FilterResult - Class in com.funnelback.filter.api: The result of filtering a document.
FilterTestRunner - Class in com.funnelback.filter.api.mock
FilterTestRunner() - Constructor for class com.funnelback.filter.api.mock.FilterTestRunner
from(FilterableDocument) - Static method in interface com.funnelback.filter.api.documents.BytesDocument: Converts a FilterableDocument into a RawFilterableDocument
from(FilterableDocument) - Static method in interface com.funnelback.filter.api.documents.StringDocument: Attempts to create a StingDocument from the given document.
from(FilterableDocument, DocumentType, String) - Static method in interface com.funnelback.filter.api.documents.StringDocument: Constructs a StringDocument from a FilterableDocument, with the given mimeType and content.
fromContentType(String) - Static method in interface com.funnelback.filter.api.DocumentType: Creates a DocumentType from HTTP header Content-Type.

G

getCharset() - Method in interface com.funnelback.filter.api.documents.NoContentDocument: Returns the possible charset of the document.
getCharset() - Method in interface com.funnelback.filter.api.documents.StringDocument: Charset of a StringDocument are always UTF-8, if the document contains any indication of charset it must be UTF-8
getCollectionName() - Method in interface com.funnelback.filter.api.FilterContext: Gets the name of the collection under which the filter is run.
getConfigKeys() - Method in interface com.funnelback.filter.api.FilterContext: Gets the set of all configuration keys for collection the filter is running under.
getConfigKeys() - Method in class com.funnelback.filter.api.mock.MockFilterContext
getConfigValue(String) - Method in interface com.funnelback.filter.api.FilterContext: Gets the value of the configuration setting for the collection the filter is running under.
getConfigValue(String) - Method in class com.funnelback.filter.api.mock.MockFilterContext
getContentAsString() - Method in interface com.funnelback.filter.api.documents.StringDocument: Gets the document content as a string.
getCopyOfContents() - Method in interface com.funnelback.filter.api.documents.FilterableDocument: Returns a copy of the documents content as bytes.
getCopyOfMetadata() - Method in interface com.funnelback.filter.api.documents.NoContentDocument: Gets a mutable copy of the documents metadata.
getDocumentType() - Method in interface com.funnelback.filter.api.documents.NoContentDocument: Returns the document type of this filterable document, this may not be the original document type.
getEmptyContext() - Static method in class com.funnelback.filter.api.mock.MockFilterContext
getFilterName() - Method in interface com.funnelback.filter.api.filters.NamedFilter: Gets the filters name.
getMessage() - Method in exception com.funnelback.filter.api.filters.FilterException
getMetadata() - Method in interface com.funnelback.filter.api.documents.NoContentDocument: Metadata of the document.
getOrGuessCharset(FilterableDocument) - Static method in interface com.funnelback.filter.api.documents.StringDocument: Gets the charset of the filterableDocument, if the charset is unknown this guesses the charset by looking at the raw bytes.
getURI() - Method in interface com.funnelback.filter.api.documents.NoContentDocument: The URI of the document.

I

isHTML() - Method in interface com.funnelback.filter.api.DocumentType
isJSON() - Method in interface com.funnelback.filter.api.DocumentType
isXML() - Method in interface com.funnelback.filter.api.DocumentType

L

logger - Static variable in interface com.funnelback.filter.api.documents.StringDocument

M

MIME_APPLICATION_JSON_TEXT - Static variable in interface com.funnelback.filter.api.DocumentType: Simple json MIME type which should be used when a filter converts a document to json.
MIME_CSV_TEXT - Static variable in interface com.funnelback.filter.api.DocumentType: Standard CSV MIME type which should be used when a filter converts a documen to CSV
MIME_HTML_TEXT - Static variable in interface com.funnelback.filter.api.DocumentType: Simple html MIME type which should be used when a filter converts a document to html.
MIME_TEXT_PLAIN - Static variable in interface com.funnelback.filter.api.DocumentType: A document type for plain text documents.
MIME_UNKNOWN - Static variable in interface com.funnelback.filter.api.DocumentType: A mime type that is unknown.
MIME_XHTML_TEXT - Static variable in interface com.funnelback.filter.api.DocumentType: Simple xhtml MIME type which should be used when a filter converts a document to xhtml.
MIME_XML_TEXT - Static variable in interface com.funnelback.filter.api.DocumentType: Simple xml MIME type which should be used when a filter converts a document to xml.
mockByteDoc(String, DocumentType, Optional<Charset>, byte[]) - Static method in interface com.funnelback.filter.api.mock.MockDocuments: Creates a mock ByteDocument
MockDocuments - Interface in com.funnelback.filter.api.mock: Use the static methods in this class to get mock document for testing.
mockEmptyByteDoc() - Static method in interface com.funnelback.filter.api.mock.MockDocuments: Creates an empty byte document for test.
mockEmptyStringDoc() - Static method in interface com.funnelback.filter.api.mock.MockDocuments: Creates an empty byte document for test.
MockFilterContext - Class in com.funnelback.filter.api.mock
mockStringDoc(String, DocumentType, String) - Static method in interface com.funnelback.filter.api.mock.MockDocuments: Constructs a mock StringDocument

N

NamedFilter - Interface in com.funnelback.filter.api.filters: Gives a name to filters for clearer logging.
NoContentDocument - Interface in com.funnelback.filter.api.documents: A document which may have its non-content parts inspected.

O

of(FilterableDocument) - Static method in class com.funnelback.filter.api.FilterResult: Returned by a filter when it has filtered a document returning a single document.
of(Collection<? extends FilterableDocument>) - Static method in class com.funnelback.filter.api.FilterResult: Returned by a filter when it has filtered a document into many documents.

P

PreFilterCheck - Enum in com.funnelback.filter.api.filters

R

runTests(Class) - Static method in class com.funnelback.filter.api.mock.FilterTestRunner

S

setConfigValue(String, String) - Method in class com.funnelback.filter.api.mock.MockFilterContext
SKIP_FILTER - com.funnelback.filter.api.filters.PreFilterCheck: Returned when the pre filter check decides that the filter can not filter the given document and so the filter should be skipped.
skipped() - Static method in class com.funnelback.filter.api.FilterResult: Marks a filter as being skipped.
StringDocument - Interface in com.funnelback.filter.api.documents: A filterable String Document
StringDocumentFilter - Interface in com.funnelback.filter.api.filters: Filter a document where the content is converted to a String.

V

valueOf(String) - Static method in enum com.funnelback.filter.api.filters.PreFilterCheck: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.funnelback.filter.api.filters.PreFilterCheck: Returns an array containing the constants of this enum type, in the order they are declared.

A B C D F G I L M N O P R S V
All Classes All Packages