BioMart::Configuration
BaseFilter
Toolbar
Summary
BioMart::Configuration::BaseFilter
Package variables
No package variables defined.
Included modules
Inherit
Synopsis
Base Interface for all BioMart filters.
Description
Base Interface for BioMart filters
Methods
Methods description
Usage : minimal (users should next set the name and dataSetName with the appropriate setter methods): my $filt = BioMart::Configuration::BaseFilter_implementation->new();
with name, and dataSetName
my $filt =
BioMart::Configuration::BaseFilter_implementation->new(
'name' => $name,
'dataSetName' => $subName);
Description: create a new BaseFilter object
Returntype : BioMart::Configuration::BaseFilter
Exceptions : none
Caller : general |
Usage : usage Description: Description Returntype : Exceptions : none Caller : caller |
Usage : usage Description: Description Returntype : Exceptions : none Caller : caller |
Usage : usage Description: Description Returntype : Exceptions : none Caller : caller |
Usage : Arg [1] - (optional) string $autoCompletion Description: get/set for autoCompletion Returntype : string Exceptions : none Caller : general |
Usage : Arg [1] - (optional) string $buttonURL Description: get/set for display name Returntype : string Exceptions : none Caller : general |
Usage : my $subName = $filt->dataSetName; $filt->dataSetName($newName); Description : get/set the name of the dataSet providing this Filter to the user. Returntype : scalar $name Exceptions : none Caller : caller |
Usage : Arg [1] - (optional) string $defaultOn Description: get/set for default on Returntype : string Exceptions : none Caller : general |
Usage : usage Description: Description Returntype : Exceptions : none Caller : caller |
Usage : Arg [1] - (optional) string $dependsOn delimited by commas Description: get/set for dependsOn atribute(s) for a dataset Returntype : string Exceptions : none Caller : general |
Usage : Arg [1] - (optional) string $dependsOnType Description: get/set for dependsOnType - all or any are acceptable. Returntype : string Exceptions : none Caller : general |
Usage : Arg [1] - (optional) string $description Description: get/set for description Returntype : string Exceptions : none Caller : general |
Usage : Arg [1] - (optional) string $display_name Description: get/set for display name Returntype : string Exceptions : none Caller : general |
Usage : Arg [1] - (optional) string $displayType Description: get/set for displayType Returntype : string Exceptions : none Caller : general |
Usage : $type = $filter->filterCollection(); Description: get filter collection filter belongs to Returntype : reference to filter collection parent Exceptions : none Caller : general |
Usage : usage Description: Description Returntype : Exceptions : none Caller : caller |
Usage : Arg [1] - (optional) string $graph Description: get/set for graph Returntype : string Exceptions : none Caller : general |
Usage : Arg [1] - (optional) string $display Description: get/set for style Returntype : string Exceptions : none Caller : general |
Usage : Arg [1] - (optional) string $imageURL Description: get/set for imageURL, a relative URL. This is only used by MartView. Returntype : string Exceptions : none Caller : general |
Usage : my $interface = $att->interface; $att->interface->($newName); Description: get/set for the name of the interface which hosts this filter. Returntype : scalar $name Exceptions : none Caller : general |
Usage : Arg [1] - (optional) string $qualifiers Description: get/set for legal_qualifiers Returntype : string Exceptions : none Caller : general |
Usage : Arg [1] - (optional) string $multipleValues Description: get/set for multipleValues Returntype : string Exceptions : none Caller : general |
Usage : my $name = $filt->name; $filt->name($newName); Description: get/set for the name of the filter Returntype : scalar $name Exceptions : none Caller : caller |
Usage : Arg [1] - (optional) string $pointedFromDataset Description: get/set for pointedFromDataset atribute(s) for a dataset Returntype : string Exceptions : none Caller : general |
Usage : Arg [1] - (optional) string $pointedFromInterface Description: get/set for pointedFromInterface atribute(s) for a dataset Returntype : string Exceptions : none Caller : general |
Usage : Arg [1] - (optional) string $setAttribute Description: get/set for set attribute Returntype : string Exceptions : none Caller : general |
Usage : Arg [1] - (optional) string $setAttributePage Description: get/set for display name Returntype : string Exceptions : none Caller : general |
Usage : Arg [1] - (optional) string $style Description: get/set for style Returntype : string Exceptions : none Caller : general |
Usage : Description: returns the table name associated with this filter; Returntype : String table name Exceptions : none Caller : caller |
Usage : my $sql = $filt->toSQL; Description: Returns the SQL where clause reprensentation for a particular BaseFilter implementation. Returntype : SQL string Exceptions : none Caller : caller |
Usage : $type = $filter->type(); Description: get filter type Returntype : string Exceptions : none Caller : general |
Methods code
sub _hashCode
{ my $self = shift;
my $digest = Digest::MD5->new;
$digest->add($self->name) if ($self->name);
$digest->add($self->displayName) if ($self->displayName);
$digest->add($self->dataSetName) if ($self->dataSetName);
return $digest->hexdigest;
}
1; } |
sub _init
{ my ($self, @param) = @_;
$self->SUPER::_init(@param);
my $proto = shift @param;
$self->attr('options', $proto->getAllOptions); } |
sub _new
{
my ($self, @param) = @_;
$self->SUPER::_new(@param);
$self->addParams(TITLES, @param);
$self->attr('options', []);
$self->attr('dependency',[]); } |
sub addDependency
{ my ($self, $resolvedDependency) = @_;
push @{$self->get('dependency')}, $resolvedDependency; } |
sub addOption
{ my ($self, $option) = @_;
my $options = $self->get('options');
push @{$options}, $option; } |
sub addOptions
{ my ($self, $new_options) = @_;
my $options = $self->get('options');
push @{$options}, @{$new_options}; } |
sub autoCompletion
{ my ($self, $value) = @_;
if ($value){
$self->setParam(AUTOCOMPLETION, $value);
}
return $self->getParam(AUTOCOMPLETION); } |
sub buttonURL
{ my ($self, $value) = @_;
if ($value){
$self->setParam(BUTTONURL, $value);
}
return $self->getParam(BUTTONURL); } |
sub dataSetName
{ my ($self, $name) = @_;
if ($name) {
$self->setParam(DATASETNAME, $name);
}
return $self->getParam(DATASETNAME); } |
sub defaultOn
{ my ($self, $value) = @_;
if ($value){
$self->setParam(DEFAULTON, $value);
}
return $self->getParam(DEFAULTON); } |
sub dependencies
{ my $self = shift;
return $self->get('dependency'); } |
sub dependsOn
{ my ($self, $value) = @_;
if ($value){
$self->setParam(DEPENDSON, $value);
}
return $self->getParam(DEPENDSON); } |
sub dependsOnType
{ my ($self, $value) = @_;
if ($value){
$self->setParam(DEPENDSONTYPE, $value);
}
return $self->getParam(DEPENDSONTYPE); } |
sub description
{ my ($self, $value) = @_;
if ($value){
$self->setParam(DESCRIPTION, $value);
}
return $self->getParam(DESCRIPTION); } |
sub displayName
{ my ($self, $value) = @_;
if ($value){
$self->setParam(DISPLAYNAME, $value);
}
return $self->getParam(DISPLAYNAME); } |
sub displayType
{ my ($self, $value) = @_;
if ($value){
$self->setParam(DISPLAYTYPE, $value);
}
return $self->getParam(DISPLAYTYPE); } |
sub filterCollection
{ my ($self, $value) = @_;
if ($value){
$self->setParam(FILTERCOLLECTION, $value);
}
return $self->getParam(FILTERCOLLECTION); } |
sub getAllOptions
{ my $self = shift;
return $self->get('options'); } |
sub graph
{ my ($self, $value) = @_;
if ($value){
$self->setParam(GRAPH, $value);
}
return $self->getParam(GRAPH); } |
sub hideDisplay
{ my ($self, $value) = @_;
if ($value){
$self->setParam(HIDEDISPLAY, $value);
}
return $self->getParam(HIDEDISPLAY); } |
sub imageURL
{ my ($self, $value) = @_;
if ($value){
$self->setParam(IMAGEURL, $value);
}
return $self->getParam(IMAGEURL); } |
sub interface
{ my ($self, $value) = @_;
if ($value){
$self->setParam(INTERFACE, $value);
}
return $self->getParam(INTERFACE); } |
sub legalQualifiers
{ my ($self, $value) = @_;
if ($value){
$self->setParam(LEGAL_QUALIFIERS, $value);
}
return $self->getParam(LEGAL_QUALIFIERS); } |
sub multipleValues
{ my ($self, $value) = @_;
if ($value){
$self->setParam(MULTIPLEVALUES, $value);
}
return $self->getParam(MULTIPLEVALUES); } |
sub name
{ my ($self, $value) = @_;
if ($value){
$self->setParam(NAME, $value);
}
return $self->getParam(NAME); } |
sub pointedFromDataset
{ my ($self, $value) = @_;
if ($value){
$self->setParam(POINTEDFROMDATASET, $value);
}
return $self->getParam(POINTEDFROMDATASET); } |
sub pointedFromInterface
{ my ($self, $value) = @_;
if ($value){
$self->setParam(POINTEDFROMINTERFACE, $value);
}
return $self->getParam(POINTEDFROMINTERFACE); } |
sub setAttribute
{ my ($self, $value) = @_;
if ($value){
$self->setParam(SETATTRIBUTE, $value);
}
return $self->getParam(SETATTRIBUTE); } |
sub setAttributePage
{ my ($self, $value) = @_;
if ($value){
$self->setParam(SETATTRIBUTEPAGE, $value);
}
return $self->getParam(SETATTRIBUTEPAGE); } |
sub style
{ my ($self, $value) = @_;
if ($value){
$self->setParam(STYLE, $value);
}
return $self->getParam(STYLE); } |
sub toSQL
{ my ($self,$oracle) = @_;
if ($self->can("_toSQL")) {
return $self->_toSQL($oracle);
}
$self->unimplemented_method; } |
sub type
{ my ($self) = @_;
return $self->getParam(TYPE); } |
General documentation
AUTHOR - Arek Kasprzyk, Syed Haider, Richard Holland, Darin London, Damian Smedley | Top |