org.abora.white.filter
Class FilterSpace

java.lang.Object
  |
  +--org.abora.white.xpp.basic.Heaper
        |
        +--org.abora.white.spaces.basic.CoordinateSpace
              |
              +--org.abora.white.filter.FilterSpace

public class FilterSpace

extends CoordinateSpace

A FilterSpace can be described mathematically as a power space of its baseSpace, i.e. the set of all subsets of the baseSpace. Each position in a FilterSpace is a Region in the baseSpace, and each Filter is a set of Regions taken from the baseSpace. See Filter for more detail.

Field Summary

protected CoordinateSpace

myBaseSpace

Fields inherited from class org.abora.white.spaces.basic.CoordinateSpace

myAscending, myDescending, myEmptyRegion, myFullRegion, myIdentityDsp

Constructor Summary

protected

FilterSpace(CoordinateSpace base)

Method Summary

int	actualHashForEqual() Defined by subclasses to produce the value returned by hashForEqual.
Filter	allFilter(XnRegion region) Essential.
Filter	anyFilter(XnRegion baseRegion) Essential.
CoordinateSpace	baseSpace() Essential.
static void	info() {Filter CLIENT} andFilter: baseRegion {XnRegion} {Filter CLIENT} anyFilter: baseRegion {XnRegion} {CoordinateSpace CLIENT} baseSpace {FilterPosition CLIENT} position: baseRegion {XnRegion}
Filter	intersectionFilter(XnRegion region) Essential.
boolean	isEqual(Heaper other) Return true if the two objects are equal.
static FilterSpace	make(CoordinateSpace base) A FilterSpace on the given base space.
static Heaper	make(Rcvr rcvr)
Filter	notSubsetFilter(XnRegion region) A filter matching any regions that is not a subset of the given region.
Filter	notSupersetFilter(XnRegion region) A filter that matches any region that is not a superset of the given region.
Filter	orFilter(ScruSet subs) A filter that matches any region that any of the filters in the set would have matched.
FilterPosition	position(XnRegion baseRegion) Essential.
void	printOn(java.io.PrintWriter oo) This should rarely be overridden.
void	sendFilterSpaceTo(Xmtr xmtr)
void	sendSelfTo(Xmtr xmtr)
Filter	subsetFilter(XnRegion region) A filter that matches any region that is a subset of the given region.
Filter	supersetFilter(XnRegion region) Essential.

Methods inherited from class org.abora.white.spaces.basic.CoordinateSpace

ascending, completeMapping, descending, emptyRegion, fetchAscending, fetchDescending, finishCreate, fullRegion, getAscending, getDescending, identityDsp, identityMapping, verify

Methods inherited from class org.abora.white.xpp.basic.Heaper

destroy, destruct, equals, hashForEqual, printContentsOn, toString

Methods inherited from class java.lang.Object

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

Field Detail

myBaseSpace

protected CoordinateSpace myBaseSpace

Constructor Detail

FilterSpace

protected FilterSpace(CoordinateSpace base)

Method Detail

actualHashForEqual

public int actualHashForEqual()

Description copied from class: Heaper

Defined by subclasses to produce the value returned by hashForEqual.

Overrides:

actualHashForEqual in class CoordinateSpace

isEqual

public boolean isEqual(Heaper other)

Description copied from class: Heaper

Return true if the two objects are equal.

Specified by:

isEqual in class CoordinateSpace

baseSpace

public CoordinateSpace baseSpace()

Essential. The CoordinateSpace of the Regions that are the input to Filters in this FilterSpace.

printOn

public void printOn(java.io.PrintWriter oo)

Description copied from class: Heaper

This should rarely be overridden. In Tofu, it prints ClassName(...), where ... is either produced by printInsideOn or is ??? if printInsideOn it not overridden.

Overrides:

printOn in class Heaper

allFilter

public Filter allFilter(XnRegion region)

Essential. A region that matches any region that contains all the Positions in, i.e. is a superset of, the given region.

anyFilter

public Filter anyFilter(XnRegion baseRegion)

Essential. A filter that matches any region that intersects the given region.

intersectionFilter

public Filter intersectionFilter(XnRegion region)

Essential. A filter that matches any region that intersects the given region.

notSubsetFilter

public Filter notSubsetFilter(XnRegion region)

A filter matching any regions that is not a subset of the given region.

notSupersetFilter

public Filter notSupersetFilter(XnRegion region)

A filter that matches any region that is not a superset of the given region.

orFilter

public Filter orFilter(ScruSet subs)

A filter that matches any region that any of the filters in the set would have matched.

position

public FilterPosition position(XnRegion baseRegion)

Essential. Given a Region in the baseSpace, make a Position which corresponds to it, so that filter->hasMember (this->position (baseRegion)) iff filter->match (baseRegion)

subsetFilter

public Filter subsetFilter(XnRegion region)

A filter that matches any region that is a subset of the given region.

supersetFilter

public Filter supersetFilter(XnRegion region)

Essential. A region that matches any region that is a superset of the given region.

sendFilterSpaceTo

public void sendFilterSpaceTo(Xmtr xmtr)

sendSelfTo

public void sendSelfTo(Xmtr xmtr)

Overrides:

sendSelfTo in class Heaper

make

public static FilterSpace make(CoordinateSpace base)

A FilterSpace on the given base space.

info

public static void info()

{Filter CLIENT} andFilter: baseRegion {XnRegion} {Filter CLIENT} anyFilter: baseRegion {XnRegion} {CoordinateSpace CLIENT} baseSpace {FilterPosition CLIENT} position: baseRegion {XnRegion}

make

public static Heaper make(Rcvr rcvr)