org.xbrlapi.aspects
Class FilterImpl

java.lang.Object
  org.xbrlapi.aspects.FilterImpl

All Implemented Interfaces:

Serializable, Filter

public class FilterImpl
extends Object
implements Filter

See Also:

Serialized Form

Constructor Summary

FilterImpl()

Method Summary

void	addCriterion(AspectValue criterion)
boolean	filtersOn(URI aspectId)
Set<Fact>	getMatchingFacts(FactSet candidateFacts)
void	removeAllCriteria() Removes all selection criteria from the filter.
void	removeCriterion(URI aspectId)

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterImpl

public FilterImpl()

Method Detail

addCriterion

public void addCriterion(AspectValue criterion)
                  throws XBRLException

Specified by:

addCriterion in interface Filter

Parameters:

criterion - The aspect value to use as a filtration selection criterion.

Throws:

XBRLException - if any of the parameters are null.

See Also:

Filter.addCriterion(AspectValue)

getMatchingFacts

public Set<Fact> getMatchingFacts(FactSet candidateFacts)

Specified by:

getMatchingFacts in interface Filter

Parameters:

candidateFacts - The facts to be filtered.

Returns:

the subset of facts with aspect values that match the aspect values that constitute the criteria in applied by the filter.

See Also:

Filter.getMatchingFacts(FactSet)

filtersOn

public boolean filtersOn(URI aspectId)

Specified by:

filtersOn in interface Filter

Parameters:

aspectId - The aspect ID for the aspect that is to have its selection criterion removed from this filter.

Returns:

true if the filter has a selection criterion for the given aspect.

See Also:

Filter.filtersOn(URI)

removeAllCriteria

public void removeAllCriteria()

Description copied from interface: Filter

Removes all selection criteria from the filter.

Specified by:

removeAllCriteria in interface Filter

See Also:

Filter.removeAllCriteria()

removeCriterion

public void removeCriterion(URI aspectId)

Specified by:

removeCriterion in interface Filter

Parameters:

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.

See Also:

Filter.removeCriterion(URI)