Mark Gannon > XBRL > XBRL::Unit

Download:
XBRL-0.03.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.03   Source  

NAME ^

XBRL::Unit - Perl Objected-Oriented Module for ecapsulating XBRL Units

SYNOPSIS ^

  use XBRL::Unit;  
                
        my $unit = XBRL::Unit->new($unit_xml);  

        my $unit_id = $unit->id():

        my $unit_measure = $unit->measure();

        my $unit_numerator = $unit->numerator(); 

        my $unit_denominator = $unit->denominator();

DESCRIPTION ^

This module is intended to work in conjunction with the XBRL module for parsing Extensible Business Reporting Language docuements.

new

Constructor for the object requires a scalar containing the XML text of the unit.

id

Returns a scalar variable with the unit's ID as assigned in the instance document.

measure

Returns a scalar variable with a string describing the measure for the unit (e.g. iso4217:USD).

numerator

Returns a scalar variable with a string describing the the numerator measure (e.g. iso4217:USD) in the event the unit is representing a division of two types of units (e.g Dollars per Share).

denominator

Returns a scalar variable with a string describing the the denominator measure (e.g. xbrli:shares) in the event the unit is representing a division of two types of units (e.g Dollars per Share).

SEE ALSO ^

Modules: XBRL XBRL::Element XBRL::Table

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: