Interface Location
- All Superinterfaces:
Accessioned,Iterable<Location>
- All Known Subinterfaces:
AccesionedLocation
- All Known Implementing Classes:
AbstractLocation,InsdcLocations.BondLocation,InsdcLocations.GroupLocation,InsdcLocations.OneOfLocation,InsdcLocations.OrderLocation,SequenceLocation,SimpleLocation
Sets of integers used to represent the location of features on sequence. A
location can be a single set of bounds or composed of multiple
sub-locations. Each sub-location is a Location and therefore subject to the
same rules.
- Author:
- ayates
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic classHelper methods for use with the Location classes. -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptiongetEnd()End of the locationintReturns the length of the outer bounds of this locationAn extension togetSubLocations()which returns sub-locations of sub-locations; this will continue until it runs out of those locations.getRelevantSubSequence(Sequence<C> sequence) Will return a SequenceReader object which offers a view of all resolved locations i.e.getStart()Start of the locationStrand which the location is located onGives access to the sub locations for this location.getSubSequence(Sequence<C> sequence) Will return a SequenceReader object which represents the outer bounds of this LocationbooleanReturns true if the position is meant to represent a point between two points such as 78^79.booleanIndicates if this location is circular.booleanReturns true if the location is considered to be complex meaning the location is actually composed of sub-locations.Methods inherited from interface org.biojava.nbio.core.sequence.template.Accessioned
getAccessionMethods inherited from interface java.lang.Iterable
forEach, iterator, spliterator
-
Field Details
-
EMPTY
Basic location which is set to the minimum and maximum bounds ofInteger.Strandis set toStrand.UNDEFINED.
-
-
Method Details
-
getStart
Point getStart()Start of the location -
getEnd
Point getEnd()End of the location -
getLength
int getLength()Returns the length of the outer bounds of this location -
getStrand
Strand getStrand()Strand which the location is located on -
getSubLocations
Gives access to the sub locations for this location. However this does not return sub-locations of sub-locations. For that functionality use#getAllSubLocations().- Returns:
- A list of a single level of sub-locations
-
getRelevantSubLocations
An extension togetSubLocations()which returns sub-locations of sub-locations; this will continue until it runs out of those locations.- Returns:
- List of all sub locations including sub-locations of sub locations
-
isComplex
boolean isComplex()Returns true if the location is considered to be complex meaning the location is actually composed of sub-locations. -
isCircular
boolean isCircular()Indicates if this location is circular. -
isBetweenCompounds
boolean isBetweenCompounds()Returns true if the position is meant to represent a point between two points such as 78^79. Only valid if start and stop are next to each other. -
getSubSequence
Will return a SequenceReader object which represents the outer bounds of this Location- Parameters:
sequence- The sequence object to work with- Returns:
- The sequence
-
getRelevantSubSequence
Will return a SequenceReader object which offers a view of all resolved locations i.e. those locations which are not complex and define the true Sequence represented- Parameters:
sequence- The sequence object to work with- Returns:
- The full assembled sequence
-