Manual Reference Pages - XML::PASTOR::SCHEMA::GROUP (3)
XML::Pastor::Schema::Group - Class that represents the META information about a W3C schema group.
This module is used internally by XML::Pastor. You do not normally know much about this module to actually use XML::Pastor. It is
documented here for completeness and for XML::Pastor developers. Do not count on the interface of this module. It may change in
any of the subsequent releases. You have been warned.
This class descends from XML::Pastor::Schema::Object.
my $g = XML::Pastor::Schema::Group->new();
$g->setFields(name => personal, scope=> global, nameIsAutoGenerated=>0);
$g->elements([lastName, firstName, title, dateOfBirth]);
print $g->name(); # prints personal.
print $g->scope();# prints global.
<B>XML::Pastor::Schema::GroupB> is a data-oriented object class that reprsents a W3C <B>groupB>. It is
parsed from the W3C schema and is used a building block for the produced <B>schema modelB>. Objects of this
class contain META information about the W3C schema <B>groupB> that they represent.
Like other schema object classes, this is a data-oriented object class, meaning it doesnt have many methods other
than a constructor and various accessors.
The new() constructor method instantiates a new object. It is inheritable.
Any -named- fields that are passed as parameters are initialized to those values within
the newly created object.
In its overriden form, what this method does is as follows:
sets the contentType field to group;
creates the <B>elementsB> array-ref field if not passed already as a parameter;
creates the <B>elementInfoB> hash-ref field if not passed already as a parameter;
Several accessors are inherited by this class from its ancestor XML::Pastor::Schema::Object.
Please see XML::Pastor::Schema::Object for a documentation of those.
Accessors defined here
my $elems = $object->elements(); # GET
$object->elements($elems); # SET
A reference to an array containing the names of the child elements that this <B>groupB> has.
The array does not take into consideration any differnce between sequence, choice, or all groupings.
my $ei = $object->elementInfo(); # GET
$object->elementInfo($ei); # SET
A reference to a hash whose keys are the names of the child elements, and whose values are
objects of type XML::Pastor::Schema::Element, that give meta information about those child elements.
BUGS & CAVEATS
There no known bugs at this time, but this doesnt mean there are arent any.
Note that, although some testing was done prior to releasing the module, this should still be considered alpha code.
So use it at your own risk.
Note that there may be other bugs or limitations that the author is not aware of.
Ayhan Ulusoy <dev(at)ulusoy(dot)name>
Copyright (C) 2006-2007 Ayhan Ulusoy. All Rights Reserved.
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
See also XML::Pastor, XML::Pastor::ComplexType, XML::Pastor::SimpleType
If you are curious about the implementation, see XML::Pastor::Schema::Parser,
If you really want to dig in, see XML::Pastor::Schema::Attribute, XML::Pastor::Schema::AttributeGroup,
XML::Pastor::Schema::ComplexType, XML::Pastor::Schema::Element, XML::Pastor::Schema::Group,
XML::Pastor::Schema::List, XML::Pastor::Schema::SimpleType, XML::Pastor::Schema::Type,
|perl v5.20.3 ||XML::PASTOR::SCHEMA::GROUP (3) ||2008-08-02 |
Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.