Package org.biojava.bibliography
Class BiblioCriterion
java.lang.Object
org.biojava.bibliography.BiblioCriterion
The criteria define how the matching or ordering should be done
during queries.
- Since:
- 1.3
- Version:
- $Id$
- Author:
- Martin Senger
-
Field Summary
FieldsModifier and TypeFieldDescriptionA name of a repository subset which this criterion is valid/used for.String[]
A list of other criteria names that this criterion is mutually exclusive with.Each Criterion is identified by its name.static final int
A query criterion.static final int
A sort criterion.int
The criteria can be used for defining rules for matching (typeQUERY_CRITERION
), or for ordering (typeSORT_CRITERION
). -
Constructor Summary
Constructors -
Method Summary
-
Field Details
-
QUERY_CRITERION
A query criterion.- See Also:
-
SORT_CRITERION
A sort criterion.- See Also:
-
name
Each Criterion is identified by its name. A list of criteria names is used in methods for querying and sorting (see
BibRefQuery
interface).The implementations are advised to use descriptive names. For example, the names for matching can be:
match all words match any word case insensitive case sensitive partial word match full word match
and the names for ordering can be:ascending descending
Another example of how to use Criteria is to allow regular expressions in queries. Not every implementation is supposed to have the capability of matching by regular expressions but those who have can specify (and document), for example, criterion with name regular expression. -
type
The criteria can be used for defining rules for matching (typeQUERY_CRITERION
), or for ordering (typeSORT_CRITERION
). -
mutuallyExclusiveWith
A list of other criteria names that this criterion is mutually exclusive with.
For example, a sort criterion ascending will probably have descending in this list.
-
forSubset
A name of a repository subset which this criterion is valid/used for.- See Also:
-
-
Constructor Details
-
BiblioCriterion
public BiblioCriterion()
-