Sanger::CGP::Vagrent::Bookmarkers::AbstractBookmarker - Abstract base class for the AnnotationGroup bookmarkers
This is an abstract base class for the AnnotationGroup bookmarkers, it provides some simple shared functionality. All subclasses must implement the _getAnnotation object method, and optionally the _init object method.
my $marker = Sanger::CGP::Vagrent::Bookmarkers::AbstractBookmarkerSubClass->new();
Builds a new Sanger::CGP::Vagrent::Bookmarkers::AbstractBookmarker inheriting object
Sanger::CGP::Vagrent::Bookmarkers::AbstractBookmarker object initialized with parameter values
Hash of parameter values, the actual keys/values required depend on the sub class.
my $markedGroup = $bookmarker->getAnnotation(@annotationGroups);
Returns the AnnotationGroup that matches the bookmark
An array of Sanger::CGP::Vagrent::Data::AnnotationGroup objects
$bookmarker->markAnnotation(@annotationGroups);
Calls getAnnotation, but marks annotation group rather than returning it
None
An array of Sanger::CGP::Vagrent::Data::AnnotationGroup objects
my $markedGroup = $self->_getAnnotation(@annotationGroups);
Abstract internal function, must be overridden by a subclass. This method should contain the actual bookmarking logic
An array of Sanger::CGP::Vagrent::Data::AnnotationGroup objects
$self->_init(@params);
Abstract internal function, optionally can be overridden by a subclass. This method is used to handle constructor parameters, its called by new.
None
The array of constructor paramaters to be parsed.