|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A biological location.
The location will contain some symbols between getMin and getMax inclusive. It is not required to contain all locations within this range. It is meant to contain getMin or getMax. In the event that an operation would produce an invalid or nonsensical range, empty should be returned.
Location objects are always immutable.
Inner Class Summary | |
static class |
Location.EmptyLocation
The implementation of Location that contains no positions at all. |
static class |
Location.LocationComparator
|
Field Summary | |
static Location |
empty
The empty range. |
static Location.LocationComparator |
naturalOrder
|
Method Summary | |
java.util.Iterator |
blockIterator()
Return an Iterator over the set of maximal contiguous sub-locations. |
boolean |
contains(int p)
Checks if this location contains a point. |
boolean |
contains(Location l)
Checks if this location contains the other. |
boolean |
equals(java.lang.Object l)
Checks if this location is equivalent to the other. |
int |
getMax()
The maximum position contained. |
int |
getMin()
The minimum position contained. |
Location |
intersection(Location l)
Returns a Location that contains all points common to both ranges. |
boolean |
isContiguous()
Determine if a Location is contiguous. |
boolean |
overlaps(Location l)
Checks if these two locations overlap, using this locations's concept of overlaping. |
SymbolList |
symbols(SymbolList seq)
Return the symbols in a sequence that fall within this range. |
Location |
translate(int dist)
Create a location that is a translation of this location. |
Location |
union(Location l)
Return a Loctaion containing all points in either ranges. |
Field Detail |
public static final Location empty
This object contains nothing. Its minimum value is Integer.MAX_VALUE. Its maximum value is Integer.MIN_VALUE. It overlaps nothing. It is equal to nothing. Intersection results in the empty range. Union results in the argument range. Symbols returns an empty array.
Every day, in every way, empty becomes more and more boring.
public static final Location.LocationComparator naturalOrder
Method Detail |
public int getMin()
public int getMax()
public boolean overlaps(Location l)
Abstractly, two locations overlap if they both contain any point.
l
- the Location to checkpublic boolean contains(Location l)
Abstractly, a location contains another if every point in the other location is contained within this one.
l
- the Location to checkpublic boolean contains(int p)
p
- the point to checkpublic boolean equals(java.lang.Object l)
Abstractly, a location is equal to another if for every point in one it is also in the other. This is equivalent to a.contains(b) && b.contains(a).
l
- the Object to checkpublic Location intersection(Location l)
l
- the Location to intersect withpublic Location union(Location l)
l
- the Location to union withpublic SymbolList symbols(SymbolList seq)
seq
- the SymbolList to processpublic Location translate(int dist)
dist
- the distance to translate (to the right)public boolean isContiguous()
true
if and only if this Location
contains every point from min
to
max
inclusive.public java.util.Iterator blockIterator()
Given any location, it can be considered to contain zero or more maximal contiguous blocks of width 1 or greater. The empty location is composed from nothing. A contiguous location is composed from itself. A non-contiguous location is composed from contiguous blocks seperated by gaps.
This method should return an Iterator over these maximally contiguous blocks starting with the left-most block, and finnishing at the right-most block.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |