public class TaxonNodeFilter
extends java.lang.Object
implements java.io.Serializable
Modifier and Type | Class and Description |
---|---|
static class |
TaxonNodeFilter.ORDER |
Constructor and Description |
---|
TaxonNodeFilter() |
TaxonNodeFilter(Classification classification) |
TaxonNodeFilter(NamedArea area) |
TaxonNodeFilter(Rank rankMin,
Rank rankMax) |
TaxonNodeFilter(Taxon taxon) |
TaxonNodeFilter(TaxonNode node)
Constructor for a given subtree represented by a
TaxonNode |
Modifier and Type | Method and Description |
---|---|
TaxonNodeFilter |
andTaxonNode(TaxonNode taxonNode) |
java.util.List<LogicFilter<NamedArea>> |
getAreaFilter() |
java.util.List<LogicFilter<Classification>> |
getClassificationFilter() |
java.util.List<LogicFilter<PresenceAbsenceTerm>> |
getDistributionStatusFilter() |
TaxonNodeFilter.ORDER |
getOrderBy() |
LogicFilter<Rank> |
getRankMax() |
LogicFilter<Rank> |
getRankMin() |
java.util.List<LogicFilter<TaxonNode>> |
getSubtreeFilter() |
java.util.List<LogicFilter<Taxon>> |
getTaxonFilter() |
java.util.List<LogicFilter<TaxonNode>> |
getTaxonNodesFilter() |
boolean |
hasClassificationFilter() |
boolean |
hasSubtreeFilter() |
boolean |
isIncludeRootNodes()
If
true the result will include the root node of
a classification. |
boolean |
isIncludeUnpublished() |
static TaxonNodeFilter |
NewClassificationInstance(Classification classification) |
static TaxonNodeFilter |
NewClassificationInstance(java.util.UUID classificationUuid) |
static TaxonNodeFilter |
NewInstance() |
static TaxonNodeFilter |
NewInstance(java.util.Collection<java.util.UUID> classificationUuids,
java.util.Collection<java.util.UUID> subtreeUuids,
java.util.Collection<java.util.UUID> taxonNodeUuids,
java.util.Collection<java.util.UUID> taxonUuids,
java.util.Collection<java.util.UUID> areaUuids,
java.util.UUID minRank,
java.util.UUID maxRank) |
static TaxonNodeFilter |
NewRankInstance(Rank rankMin,
Rank rankMax) |
static TaxonNodeFilter |
NewSubtreeInstance(TaxonNode subtree) |
static TaxonNodeFilter |
NewSubtreeInstance(java.util.UUID subtreeUuid) |
static TaxonNodeFilter |
NewTaxonInstance(Taxon taxon) |
static TaxonNodeFilter |
NewTaxonInstance(java.util.UUID taxonUuid) |
static TaxonNodeFilter |
NewTaxonNodeInstance(TaxonNode taxonNode) |
static TaxonNodeFilter |
NewTaxonNodeInstance(java.util.UUID taxonNodeUuid) |
TaxonNodeFilter |
notSubtree(TaxonNode taxonNode) |
TaxonNodeFilter |
notTaxon(Taxon taxon) |
TaxonNodeFilter |
notTaxonNode(TaxonNode taxonNode) |
TaxonNodeFilter |
orArea(NamedArea area) |
TaxonNodeFilter |
orArea(java.util.UUID uuid) |
TaxonNodeFilter |
orClassification(Classification classification) |
TaxonNodeFilter |
orClassification(java.util.UUID uuid) |
TaxonNodeFilter |
orSubtree(TaxonNode taxonNode) |
TaxonNodeFilter |
orSubtree(java.util.UUID taxonNodeUuid) |
TaxonNodeFilter |
orTaxon(Taxon taxon) |
TaxonNodeFilter |
orTaxon(java.util.UUID uuid) |
TaxonNodeFilter |
orTaxonNode(TaxonNode taxonNode)
Adds a single
TaxonNode to the filter.NOTE: this adds only the node to the filter, not it's children! |
TaxonNodeFilter |
orTaxonNode(java.util.UUID uuid)
Adds a single
TaxonNode to the filter.NOTE: this adds only the node to the filter, not it's children! |
void |
reset() |
TaxonNodeFilter |
setIncludeRootNodes(boolean includeRootNodes) |
void |
setIncludeUnpublished(boolean includeUnpublished) |
void |
setOrder(TaxonNodeFilter.ORDER orderBy) |
TaxonNodeFilter |
setRankMax(Rank rankMax) |
TaxonNodeFilter |
setRankMax(java.util.UUID rankMaxUuid) |
TaxonNodeFilter |
setRankMin(Rank rankMin) |
TaxonNodeFilter |
setRankMin(java.util.UUID rankMinUuid) |
java.lang.String |
toString() |
public TaxonNodeFilter()
public TaxonNodeFilter(TaxonNode node)
TaxonNode
public TaxonNodeFilter(Classification classification)
public TaxonNodeFilter(NamedArea area)
public TaxonNodeFilter(Taxon taxon)
public static TaxonNodeFilter NewTaxonNodeInstance(java.util.UUID taxonNodeUuid)
public static TaxonNodeFilter NewTaxonNodeInstance(TaxonNode taxonNode)
public static TaxonNodeFilter NewClassificationInstance(java.util.UUID classificationUuid)
public static TaxonNodeFilter NewClassificationInstance(Classification classification)
public static TaxonNodeFilter NewSubtreeInstance(java.util.UUID subtreeUuid)
public static TaxonNodeFilter NewSubtreeInstance(TaxonNode subtree)
public static TaxonNodeFilter NewTaxonInstance(java.util.UUID taxonUuid)
public static TaxonNodeFilter NewTaxonInstance(Taxon taxon)
public static TaxonNodeFilter NewRankInstance(Rank rankMin, Rank rankMax)
public static TaxonNodeFilter NewInstance()
public static TaxonNodeFilter NewInstance(java.util.Collection<java.util.UUID> classificationUuids, java.util.Collection<java.util.UUID> subtreeUuids, java.util.Collection<java.util.UUID> taxonNodeUuids, java.util.Collection<java.util.UUID> taxonUuids, java.util.Collection<java.util.UUID> areaUuids, java.util.UUID minRank, java.util.UUID maxRank)
public void reset()
public java.util.List<LogicFilter<TaxonNode>> getSubtreeFilter()
public java.util.List<LogicFilter<TaxonNode>> getTaxonNodesFilter()
public java.util.List<LogicFilter<Classification>> getClassificationFilter()
public java.util.List<LogicFilter<Taxon>> getTaxonFilter()
public java.util.List<LogicFilter<NamedArea>> getAreaFilter()
public java.util.List<LogicFilter<PresenceAbsenceTerm>> getDistributionStatusFilter()
public TaxonNodeFilter orSubtree(TaxonNode taxonNode)
public TaxonNodeFilter notSubtree(TaxonNode taxonNode)
public TaxonNodeFilter orSubtree(java.util.UUID taxonNodeUuid)
public TaxonNodeFilter orTaxonNode(TaxonNode taxonNode)
TaxonNode
to the filter.public TaxonNodeFilter orTaxonNode(java.util.UUID uuid)
TaxonNode
to the filter.public TaxonNodeFilter notTaxonNode(TaxonNode taxonNode)
public TaxonNodeFilter andTaxonNode(TaxonNode taxonNode)
public TaxonNodeFilter orTaxon(Taxon taxon)
public TaxonNodeFilter orTaxon(java.util.UUID uuid)
public TaxonNodeFilter orArea(java.util.UUID uuid)
public TaxonNodeFilter orArea(NamedArea area)
public TaxonNodeFilter setRankMin(Rank rankMin)
public TaxonNodeFilter setRankMin(java.util.UUID rankMinUuid)
public TaxonNodeFilter setRankMax(Rank rankMax)
public TaxonNodeFilter setRankMax(java.util.UUID rankMaxUuid)
public TaxonNodeFilter orClassification(Classification classification)
public TaxonNodeFilter orClassification(java.util.UUID uuid)
public TaxonNodeFilter notTaxon(Taxon taxon)
public LogicFilter<Rank> getRankMax()
public LogicFilter<Rank> getRankMin()
public boolean isIncludeUnpublished()
public void setIncludeUnpublished(boolean includeUnpublished)
public boolean isIncludeRootNodes()
true
the result will include the root node of
a classification.
Note: As a root node per se has no taxon all filters with filter
on taxon related data have no effect for the root node. If the
root node is returned only depends on the
includeRootNodes
parameter.public TaxonNodeFilter setIncludeRootNodes(boolean includeRootNodes)
public boolean hasClassificationFilter()
public boolean hasSubtreeFilter()
public TaxonNodeFilter.ORDER getOrderBy()
public void setOrder(TaxonNodeFilter.ORDER orderBy)
public java.lang.String toString()
toString
in class java.lang.Object
Copyright © 2007-2020 EDIT. All Rights Reserved.