org.sbolstandard.core2

Class Location

java.lang.Object

org.sbolstandard.core2.Identified

org.sbolstandard.core2.Location

All Implemented Interfaces:

Comparable<Location>

Direct Known Subclasses:

Cut, GenericLocation, Range

public abstract class Location
extends Identified
implements Comparable<Location>

Represents a Location object in the SOBL data model.

Version:

2.1

Author:

Zhen Zhang, Nicholas Roehner, Chris Myers

Method Summary

Modifier and Type	Method and Description
OrientationType	getOrientation() Returns the orientation property of this location.
Sequence	getSequence() Returns the sequence referenced by this location.
URI	getSequenceIdentity() Returns the sequence identity referenced by this location.
URI	getSequenceURI() Returns the sequence URI referenced by this location.
boolean	isSetOrientation() Checks if the orientation property is set.
boolean	isSetSequence() Checks if the sequence property is set.
void	setOrientation(OrientationType orientation) Sets the orientation property of this location to the given one.
void	setSequence(URI sequence) Sets the sequence property to the given one.
String	toString()
void	unsetOrientation() Sets the orientation property of this location to null.
void	unsetSequence() Sets the sequence property of this location to null.

Methods inherited from class org.sbolstandard.core2.Identified

addWasDerivedFrom, addWasGeneratedBy, clearAnnotations, clearWasDerivedFroms, clearWasGeneratedBys, containsWasDerivedFrom, containsWasGeneratedBy, createAnnotation, createAnnotation, createAnnotation, createAnnotation, createAnnotation, createAnnotation, equals, getAnnotation, getAnnotations, getDescription, getDisplayId, getIdentity, getName, getPersistentIdentity, getVersion, getWasDerivedFrom, getWasDerivedFroms, getWasGeneratedBys, hasAnnotations, hashCode, isSetDescription, isSetDisplayId, isSetName, isSetPersistentIdentity, isSetVersion, isSetWasDerivedFrom, removeAnnotation, removeWasDerivedFrom, removeWasGeneratedBy, setDescription, setName, setWasDerivedFrom, setWasDerivedFroms, setWasGeneratedBys, unsetDescription, unsetName, unsetWasDerivedFrom

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

isSetOrientation

public boolean isSetOrientation()

Checks if the orientation property is set.

Returns:

true if it is not null, false otherwise

getOrientation

public OrientationType getOrientation()

Returns the orientation property of this location.

Returns:

the orientation property of this location

setOrientation

public void setOrientation(OrientationType orientation)

Sets the orientation property of this location to the given one.

Parameters:

orientation - the orientation to set to

unsetOrientation

public void unsetOrientation()

Sets the orientation property of this location to null.

isSetSequence

public boolean isSetSequence()

Checks if the sequence property is set.

Returns:

true if it is not null, false otherwise

getSequenceURI

public URI getSequenceURI()

Returns the sequence URI referenced by this location.

Returns:

the sequence URI referenced by this location.

getSequenceIdentity

public URI getSequenceIdentity()

Returns the sequence identity referenced by this location.

Returns:

null if the associated SBOLDocument instance is null or no matching sequence referenced by this location exists; or the matching sequence otherwise.

getSequence

public Sequence getSequence()

Returns the sequence referenced by this location.

Returns:

null if the associated SBOLDocument instance is null or no matching sequence referenced by this location exists; or the matching sequence otherwise.

setSequence

public void setSequence(URI sequence)
                 throws SBOLValidationException

Sets the sequence property to the given one.

Parameters:

sequence - the given sequence URI to set to

Throws:

SBOLValidationException - if the following SBOL validation rules was violated: 11003.

unsetSequence

public void unsetSequence()

Sets the sequence property of this location to null.

toString

public String toString()

Overrides:

toString in class Identified