com.groupdocs.search

Class DocumentFilter

java.lang.Object

com.groupdocs.search.DocumentFilter

public abstract class DocumentFilter
extends Object

Represents the base class for document filters. Contains methods for creation document filter instances.

Learn more

• Document filtering during indexing

Constructor Summary

Constructors

Constructor and Description
DocumentFilter()

Method Summary

Modifier and Type	Method and Description
static DocumentFilter	createAnd(DocumentFilter... filters) Creates a logical conjunction of the specified filters.
static DocumentFilter	createCreationTimeLowerBound(Date lowerBound) Creates a filter for skipping documents with creation date earlier than the lower bound.
static DocumentFilter	createCreationTimeRange(Date lowerBound, Date upperBound) Creates a filter for skipping documents with creation date out of the specified range.
static DocumentFilter	createCreationTimeUpperBound(Date upperBound) Creates a filter for skipping documents with creation date later than the upper bound.
static DocumentFilter	createFileExtension(String... extensions) Creates a filter for skipping documents that do not have allowable extension.
static DocumentFilter	createFileLengthLowerBound(long lowerBound) Creates a filter for skipping documents with the length less than the lower bound.
static DocumentFilter	createFileLengthRange(long lowerBound, long upperBound) Creates a filter for skipping documents out of the specified document length range.
static DocumentFilter	createFileLengthUpperBound(long upperBound) Creates a filter for skipping documents with the length greater than the upper bound.
static DocumentFilter	createFilePathRegularExpression(String pattern) Creates a filter for skipping documents that are not match a regular expression.
static DocumentFilter	createFilePathRegularExpression(String pattern, int options) Creates a filter for skipping documents that are not match a regular expression.
static DocumentFilter	createModificationTimeLowerBound(Date lowerBound) Creates a filter for skipping documents with modification date earlier than the lower bound.
static DocumentFilter	createModificationTimeRange(Date lowerBound, Date upperBound) Creates a filter for skipping documents with modification date out of the specified range.
static DocumentFilter	createModificationTimeUpperBound(Date upperBound) Creates a filter for skipping documents with modification date later than the upper bound.
static DocumentFilter	createNot(DocumentFilter innerFilter) Creates a filter that has inverse logic in relation to the specified inner filter.
static DocumentFilter	createOr(DocumentFilter... filters) Creates a logical disjunction of the specified filters.
protected static boolean	customEquals(DocumentFilter left, DocumentFilter right)
protected static DocumentFilter	deserializeProtected(com.aspose.ms.System.IO.Stream stream)
protected static void	serialize(DocumentFilter filter, com.aspose.ms.System.IO.Stream stream)
abstract String	toString() Returns string representation of a document filter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DocumentFilter

public DocumentFilter()

Method Detail

createAnd

public static DocumentFilter createAnd(DocumentFilter... filters)

Creates a logical conjunction of the specified filters.

Parameters:

filters - The document filters.

Returns:

A document filter that represents result of conjunction of the specified filters.

createCreationTimeLowerBound

public static DocumentFilter createCreationTimeLowerBound(Date lowerBound)

Creates a filter for skipping documents with creation date earlier than the lower bound.

Parameters:

lowerBound - The lower bound of the document creation time.

Returns:

A document filter by document creation time.

createCreationTimeRange

public static DocumentFilter createCreationTimeRange(Date lowerBound,
                                                     Date upperBound)

Creates a filter for skipping documents with creation date out of the specified range.

Parameters:

lowerBound - The lower bound of the document creation time.

upperBound - The upper bound of the document creation time.

Returns:

A document filter by document creation time.

createCreationTimeUpperBound

public static DocumentFilter createCreationTimeUpperBound(Date upperBound)

Creates a filter for skipping documents with creation date later than the upper bound.

Parameters:

upperBound - The upper bound of the document creation time.

Returns:

A document filter by document creation time.

createFileExtension

public static DocumentFilter createFileExtension(String... extensions)

Creates a filter for skipping documents that do not have allowable extension.

Parameters:

extensions - The list of allowable extensions.

Returns:

A document filter by document extension.

createFileLengthLowerBound

public static DocumentFilter createFileLengthLowerBound(long lowerBound)

Creates a filter for skipping documents with the length less than the lower bound.

Parameters:

lowerBound - The lower bound of the document length.

Returns:

A document filter by document length.

createFileLengthRange

public static DocumentFilter createFileLengthRange(long lowerBound,
                                                   long upperBound)

Creates a filter for skipping documents out of the specified document length range.

Parameters:

lowerBound - The lower bound of the document length.

upperBound - The upper bound of the document length.

Returns:

A document filter by document length.

createFileLengthUpperBound

public static DocumentFilter createFileLengthUpperBound(long upperBound)

Creates a filter for skipping documents with the length greater than the upper bound.

Parameters:

upperBound - The upper bound of the document length.

Returns:

A document filter by document length.

createFilePathRegularExpression

public static DocumentFilter createFilePathRegularExpression(String pattern)

Creates a filter for skipping documents that are not match a regular expression. The regular expression is applied to the full path of a document.

Parameters:

pattern - The regular expression pattern.

Returns:

A document filter by file name.

createFilePathRegularExpression

public static DocumentFilter createFilePathRegularExpression(String pattern,
                                                             int options)

Creates a filter for skipping documents that are not match a regular expression. The regular expression is applied to the full path of a document.

Parameters:

pattern - The regular expression pattern.

options - The regular expression options.

Returns:

A document filter by file name.

createModificationTimeLowerBound

public static DocumentFilter createModificationTimeLowerBound(Date lowerBound)

Creates a filter for skipping documents with modification date earlier than the lower bound.

Parameters:

lowerBound - The lower bound of the document modification time.

Returns:

A document filter by document modification time.

createModificationTimeRange

public static DocumentFilter createModificationTimeRange(Date lowerBound,
                                                         Date upperBound)

Creates a filter for skipping documents with modification date out of the specified range.

Parameters:

lowerBound - The lower bound of the document modification time.

upperBound - The upper bound of the document modification time.

Returns:

A document filter by document modification time.

createModificationTimeUpperBound

public static DocumentFilter createModificationTimeUpperBound(Date upperBound)

Creates a filter for skipping documents with modification date later than the upper bound.

Parameters:

upperBound - The upper bound of the document modification time.

Returns:

A document filter by document modification time.

createNot

public static DocumentFilter createNot(DocumentFilter innerFilter)

Creates a filter that has inverse logic in relation to the specified inner filter.

Parameters:

innerFilter - The inner document filter.

Returns:

An inverted document filter.

createOr

public static DocumentFilter createOr(DocumentFilter... filters)

Creates a logical disjunction of the specified filters.

Parameters:

filters - The document filters.

Returns:

A document filter that represents result of disjunction of the specified filters.

customEquals

protected static boolean customEquals(DocumentFilter left,
                                      DocumentFilter right)

deserializeProtected

protected static DocumentFilter deserializeProtected(com.aspose.ms.System.IO.Stream stream)

serialize

protected static void serialize(DocumentFilter filter,
                                com.aspose.ms.System.IO.Stream stream)

toString

public abstract String toString()

Returns string representation of a document filter.

Overrides:

toString in class Object

Returns:

String representation of a document filter.