|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.biojava.bibliography.BiblioCriterion
public class BiblioCriterion
The criteria define how the matching or ordering should be done during queries.
Field Summary | |
---|---|
String |
forSubset
A name of a repository subset which this criterion is valid/used for. |
String[] |
mutuallyExclusiveWith
A list of other criteria names that this criterion is mutually exclusive with. |
String |
name
Each Criterion is identified by its name. |
static int |
QUERY_CRITERION
A query criterion. |
static int |
SORT_CRITERION
A sort criterion. |
int |
type
The criteria can be used for defining rules for matching (type QUERY_CRITERION ), or for ordering (type SORT_CRITERION ). |
Constructor Summary | |
---|---|
BiblioCriterion()
|
Method Summary |
---|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int QUERY_CRITERION
public static final int SORT_CRITERION
public String 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 matchand the names for ordering can be:
ascending descendingAnother 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.
public int type
QUERY_CRITERION
), or for ordering (type SORT_CRITERION
).
public String[] 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.
public String forSubset
BiblioEntryStatus.repositorySubset
Constructor Detail |
---|
public BiblioCriterion()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |