public interface Filter
extends java.io.Serializable
A filter defines a filtration of a set of facts based upon aspect value matching.
A filter only uses one aspect value for a given aspect.
Modifier and Type | Method and Description |
---|---|
void |
addCriterion(AspectValue criterion) |
boolean |
filtersOn(java.lang.String aspectId) |
java.util.Set<Fact> |
getMatchingFacts(FactSet candidateFacts) |
void |
removeAllCriteria()
Removes all selection criteria from the filter.
|
void |
removeCriterion(java.lang.String aspectId) |
void addCriterion(AspectValue criterion) throws XBRLException
criterion
- The aspect value to use as a filtration selection
criterion.XBRLException
- if any of the parameters are null.void removeCriterion(java.lang.String aspectId)
aspectId
- The aspect ID for the aspect that is to have its selection
criterion removed from this filter. This method does nothing if the
filter is not currently applying a criterion for the specified aspect.void removeAllCriteria()
boolean filtersOn(java.lang.String aspectId)
aspectId
- The aspect ID for the aspect that is to have its selection
criterion removed from this filter.