Mark Gannon > XBRL > XBRL::TableXML

Download:
XBRL-0.03.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.03   Source  

XBRL::TableXML ^

XBRL::TableXML - OO Module for Encapsulating XBRL Tables in XML

SYNOPSIS ^

  use XBRL::TableXML;
        
        my $xml_table = XBRL::TableXML->new($xbrl_doc, $uri); 

        $xml_table->addHeader(@col_labels);     

        my $colum_headers = $xml_table->getHeader(); 
        
        $xml_table->addRow($label, @row_values);        

        $xml_table->setCell($row_number, $col_number, $text_value);

        my $cell_contents = $xml_table->getCell($row_number, $col_number);

        my $rows = $xml_table->getRows();

        my $number_rows = $xml_table->getTableRows();
        
        $xml_table->label($row_number, $label); 

        my $row_label = $xml_table->label($row_number);

        my $xml_text = $xml_table->as_text();

        my $xbrl_tags = $xml_table->get_ids();

DESCRIPTION ^

This module is part of the XBRL modules group and is intended for use with XBRL.

new
                use XBRL::TableXML;
                my $xml_table = XBRL::TableXML->new($xbrl_doc, $uri); 

Object contstructor. Takes an XBRL object as well as a URI specifying which section to create a table from.

addHeader
                $xml_table->addHeader(@col_labels);     

Adds text entries to the column headers. Should include a blank or ' ' as the first entry.

getHeader
        my $colum_headers = $xml_table->getHeader(); 

Returns an array reference with the text values for the column headers

addRow
                $xml_table->addRow($label, @row_values);        

Adds a row to the end of the table. The label can either be specified seperately, or included as the first entry in the array of values.

setCell
        $xml_table->setCell($row_number, $col_number, $text_value);

Sets content for the specified cell.

getCell
        my $cell_contents = $xml_table->getCell($row_number, $col_number);

Returns the text value of the specified cell.

getRows
        my $rows = $xml_table->getRows();

Returns an array ref where each item is a tab seperated list of the rows contents.

getTableRows
        my $number_rows = $xml_table->getTableRows();

Returns the number of rows (exclusive of the header row) in the table.

label
        $xml_table->label($row_number, $label); 
        my $row_label = $xml_table->label($row_number);

If the label value is included sets the label for the row. If no label value is included, returns the label value for the row.

as_text
        my $xml_text = $xml_table->as_text();

Returns the XML table as text.

get_ids
        my $xbrl_tags = $xml_table->get_ids();

Returns an array reference with a list of all the XBRL tags (one per row).

AUTHOR ^

Mark Gannon <mark@truenorth.nu>

SEE ALSO ^

Modules: XBRL

Source code, documentation, and bug tracking is hosted at: https://github.com/MarkGannon/XBRL .

AUTHOR ^

Mark Gannon <mark@truenorth.nu>

COPYRIGHT AND LICENSE ^

Copyright (C) 2012 by Mark Gannon

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.10 or, at your option, any later version of Perl 5 you may have available.

syntax highlighting: