Toolbar

Summary

BioMart::Formatter::CSV

Package variables

Included modules

Inherit

BioMart::FormatterI

Synopsis

The CSV Formatter returns comma separated tabular data
for a BioMart query's ResultTable

Description

When given a BioMart::ResultTable containing the results of
a BioMart::Query the CSV Formatter will return tabular output
with one line for each row of data in the ResultTable and commas
separating the individual entries in each row. The getDisplayNames
and getFooterText can be used to return appropiately formatted
headers and footers respectively

Methods

Methods description

None available.

Methods code

sub _new {

    my ($self) = @_;

    $self->SUPER::_new();

}

sub getDisplayNames {

    my $self = shift;
    my @displayNames = $self->getTextDisplayNames();

    # Enclose non-numeric values in double quotes & escape the quotes already in them
    foreach(@displayNames) {
	if($_ !~ /\A[\d\.]+\z/ && $_ =~ /$FIELD_DELIMITER/) {
	    $_ =~ s/$FIELD_ENCLOSER/\$FIELD_ENCLOSER/g;
  	    $_ = $FIELD_ENCLOSER . $_ . $FIELD_ENCLOSER;
 	}
    }

    # Create the final header string
    return join($FIELD_DELIMITER, @displayNames) . $RECORD_DELIMITER;
}

1;

}

sub nextRow {

    my $self = shift;
    
    my $rtable = $self->get('result_table');
    my $row = $rtable->nextRow;
    if (!$row){
        return;
    }

    # Enclose non-numeric values in double quotes & escape the quotes already in them
    foreach(@{$row}) {
	$_ = q{} unless defined ($_);
	if($_ !~ /\A[\d\.]+\z/ && $_ =~ /$FIELD_DELIMITER/) {
	    $_ =~ s/$FIELD_ENCLOSER/\$FIELD_ENCLOSER/g;
  	    $_ = $FIELD_ENCLOSER . $_ . $FIELD_ENCLOSER;
 	}
    }
    
    # Create the final record-string
    return join($FIELD_DELIMITER, @{$row}) . $RECORD_DELIMITER;

}

sub processQuery {

    my ($self, $query) = @_;

    $self->set('original_attributes',[@{$query->getAllAttributes()}]) 
	if ($query->getAllAttributes());
    $self->set('query',$query);
    return $query;

}

General documentation

This module is part of the BioMart project
http://www.biomart.org
Questions can be posted to the mart-dev mailing list: mart-dev@ebi.ac.uk