CONSTRUCTORS

  $class->new(%fields)

CONSTRUCTOR.

The new() constructor method instantiates a new object. It is inheritable. Normally, one does not call the new method on XML::Pastor::Schema::Object. One rather calls it on the descendant subclasses.

Any -named- fields that are passed as parameters are initialized to those values within the newly created object.

.

ACCESSORS

  my $class = $object->class(); # GET
  $object->class($class);           # SET

This is the Perl class that corresponds to the schema object. It is computed at schema model resolution time. (see "resolve()" in XML::Pastor::Schema::Model).

This accessor is originally created by a call to mk_accessors from Class::Accessor. However, it is further overridden in the source code in order to take into consideration the definition of the object. The SET functionality works as usual, but the GET functionality works as follows: If a value is NOT already defined for this field, but if there is a definition of this object, then the value of the same field is returned from the definition of the object. (See "definition()").

definition()

  my $definition = $object->definition();       # GET
  $object->definition($definition);         # SET

This field corresponds to the perl reference (ref) to a resolved W3C reference to a global object. It is normally used for elements and attributes. This way, the local element definition is preserved while having a pointer to the actual global definition.

This field is set during the schema model resolution time (see "resolve()" in XML::Pastor::Schema::Model).

This accessor is created by a call to mk_accessors from Class::Accessor.

key()

  my $key = $object->key();     # GET
  $object->key($key);       # SET

Returns the hash key that is to be use to hash this object within the model. This is used by the add() method of the schema model (see "add()" in XML::Pastor::Schema::Model). If no key has been previously set, it returns the name of the object.

This accessor is coded manually.

id()

  my $id = $object->id();       # GET
  $object->id($id);         # SET

This is a W3C property.

A schema object can have an ID within the W3C schema. Currently, this property is not used by XML::Pastor.

isRedefinable()

  my $bool = $object->isRedefinable();  # GET
  $object->isRedefinable($bool);            # SET

Normally, when an object is not marked as 'redefinable', it is an error to attempt to define it again within the schema model. (see "add()" in XML::Pastor::Schema::Model).

When processing a schema within a 'redefine' block, all schema objects (including types and elements) are marked as redefinable. This way, any subsequent redefinition in the model does not cause an error.

This accessor is created by a call to mk_accessors from Class::Accessor.

name()

  my $name = $object->name();   # GET
  $object->name($name);             # SET

This is a W3C property.

This field is the name of the schema object as defined within the W3C schema or as attributed by the parser. Normally, all global objects (type, element, group, attribute, attributeGroup) will have a named defined in the W3C schema. However, non-global objects (such as local elements) will not have a name that comes from the W3C schema. Such objects will be named by the parser.

This accessor is created by a call to mk_accessors from Class::Accessor.

nameIsAutoGenerated()

  my $bool = $object->nameIsAutoGenerated();    # GET
  $object->nameIsAutoGenerated($bool);              # SET

Normally, all global objects (type, element, group, attribute, attributeGroup) will have a named defined in the W3C schema. However, non-global objects (such as local elements) will not have a name that comes from the W3C schema. Such objects will be named by the parser. In this case (when the name is generated automatically), this field will be set to TRUE(1) by the parser on the corresponding sceham object.

This accessor is created by a call to mk_accessors from Class::Accessor.

ref()

  my $ref = $object->ref();     # GET
  $object->ref($ref);       # SET

This is a W3C property.

Sometimes in a W3C schema, a local object (such as an element) makes a reference to a global object (such as a global element). In this case, the 'ref' field will contain the name of the referenced global object.

The value of this field comes directly from the W3C schema, and is put into this field by the schema parser.

This accessor is created by a call to mk_accessors from Class::Accessor.

scope()

  my $scope = $object->scope(); # GET
  $object->scope($scope);           # SET

All schema objects are defined within a scope. The scope can be 'global' or 'local'. The scope of schema objects are determined by the schema parser and this field is set accordingly at parse time.

This accessor is created by a call to mk_accessors from Class::Accessor.

type()

  my $type = $object->type();   # GET
  $object->type($type);             # SET

This is a W3C property.

Sometimes in a W3C schema, an object (such as an attribute or an element) will refer to a type that is defined globally in the schema set. The value of this field comes directly from the W3C schema, and is put into this field by the schema parser.

This accessor is originally created by a call to mk_accessors from Class::Accessor. However, it is further overridden in the source code in order to take into consideration the definition of the object. The SET functionality works as usual, but the GET functionality works as follows: If a value is NOT already defined for this field, but if there is a definition of this object, then the value of the same field is returned from the definition of the object. (See "definition()").

OTHER METHODS

  $object->setFields(%fields);

OBJECT METHOD.

This method is used to set multiple fields of a schema object all at once. From an interface point of view, it is like the new() method, but instead of constructing a new object, it works on an existing object.

Example :

  $object->setFields(
                     name=> country,
                     scope=>global
                     );

This is used heavily by the parser in order to set multiple fields that are obtained by parsing attributes from the schema nodes.