/ 
BPM-XPDL-0.04
River stage one • 1 direct dependent • 1 total dependent
/ BPM::XPDL

NAME

BPM::XPDL - XPDL access

INHERITANCE

BPM::XPDL
  is a XML::Compile::Cache
  is a XML::Compile::Schema
  is a XML::Compile

SYNOPSIS

my $xpdl = BPM::XPDL->new(version => '2.1');
$xpdl->importDefinitions(...);
my $xml  = $xpdl->writer($sometype)->($doc, $perldata);

my ($type, $data) = $xpdl->from('data.xml');
my ($type, $data) = BPM::XPDL->from('data.xml');
print "Root type: $type\n";
print Dumper $data;    # from Data::Dumper

$xpdl->addKeyRewrite('PREFIXED');
my $xml = $xpdl->create($data);
print $xml->toString(1);

DESCRIPTION

This module provides access to the Process Description Language, as defined by the WfMC, the Workflow Management Coalition (wfmc.org) You can read and create() these XPDL files with one simpe method.

All versions of the specification are supported. It will convert older versions into newer versions if you want to. See from().

Limitiations

The XPDL files may contain additional external type definitions, which are not imported/included in the specification. You need to import those explictly by hand. See t/20sample.t

TypeDeclarations are part of the interpretation of the messages which are exchanged between the Applications, and therefore not interpreted by this module.

METHODS

Constructors

$obj->from(XMLDATA, OPTIONS)

BPM::XPDL->from(XMLDATA, OPTIONS)

    Read an XML message, in any format supported by XML::Compile method dataToXML(): string, file, filehandle, and more. Returned is a list of two: the type of the top-level element plus the data-structure.

    When called as instance method, the data will automatically get converted to the version of required by the object. When called as class method, the version of the top-level element will determine the returned version automatically (which may give unpredictable versions as result).

    When the method is called as class method, then a temporary instance is created. Creating an instance is (very) slow.

    example:

    my $xpdl          = BPM::XPDL->new(version => '2.1');
my ($type, $data) = $xpdl->from('data.xml');

    or

    my ($type, $data) = BPM::XPDL->from('data.xml');

BPM::XPDL->new(OPTIONS)

    Option            --Defined in     --Default
allow_undeclared    XML::Compile::Cache  <false>
any_element         XML::Compile::Cache  'SKIP_ALL'
block_namespace     XML::Compile::Schema  []
hook                XML::Compile::Schema  undef
hooks               XML::Compile::Schema  []
ignore_unused_tags  XML::Compile::Schema  <false>
key_rewrite         XML::Compile::Schema  []
opts_readers        XML::Compile::Cache  []
opts_rw             XML::Compile::Cache  []
opts_writers        XML::Compile::Cache  []
prefix_keys                          <true>
prefixes            XML::Compile::Cache  <smart>
schema_dirs         XML::Compile     undef
typemap             XML::Compile::Schema  {}

    . allow_undeclared => BOOLEAN

    . any_element => CODE|'TAKE_ALL'|'SKIP_ALL'|'ATTEMPT'|'SLOPPY'

    . block_namespace => NAMESPACE|TYPE|HASH|CODE|ARRAY

    . hook => ARRAY-WITH-HOOKDATA | HOOK

    . hooks => ARRAY-OF-HOOK

    . ignore_unused_tags => BOOLEAN|REGEXP

    . key_rewrite => HASH|CODE|ARRAY-of-HASH-and-CODE

    . opts_readers => HASH|ARRAY-of-PAIRS

    . opts_rw => HASH|ARRAY-of-PAIRS

    . opts_writers => HASH|ARRAY-of-PAIRS

    . prefix_keys => BOOLEAN

      Enables the visibility of the various XPDL namespaces which can be merged within one document.

    . prefixes => HASH|ARRAY-of-PAIRS

    . schema_dirs => DIRECTORY|ARRAY-OF-DIRECTORIES

    . typemap => HASH

Accessors

$obj->addHook(HOOKDATA|HOOK|undef)

$obj->addHooks(HOOK, [HOOK, ...])

$obj->addKeyRewrite(PREDEF|CODE|HASH, ...)

$obj->addSchemaDirs(DIRECTORIES|FILENAME)

BPM::XPDL->addSchemaDirs(DIRECTORIES|FILENAME)

$obj->addSchemas(XML, OPTIONS)

$obj->addTypemap(PAIR)

$obj->addTypemaps(PAIRS)

$obj->allowUndeclared([BOOLEAN])

$obj->blockNamespace(NAMESPACE|TYPE|HASH|CODE|ARRAY)

$obj->hooks

$obj->namespace

$obj->prefix(PREFIX)

$obj->prefixFor(URI)

$obj->prefixed(TYPE)

$obj->prefixes([PAIRS|ARRAY|HASH])

$obj->useSchema(SCHEMA, [SCHEMA])

$obj->version

Compilers

$obj->compile(('READER'|'WRITER'), TYPE, OPTIONS)

$obj->compileAll(['READER'|'WRITER'|'RW', [NAMESPACE]])

BPM::XPDL->dataToXML(NODE|REF-XML-STRING|XML-STRING|FILENAME|FILEHANDLE|KNOWN)

$obj->reader(TYPE|NAME, OPTIONS)

$obj->template('XML'|'PERL', TYPE, OPTIONS)

$obj->writer(TYPE|NAME)

Administration

$obj->declare('READER'|'WRITER'|'RW', TYPE|ARRAY-of-TYPES, OPTIONS)

$obj->elements

$obj->findName(NAME)

$obj->findSchemaFile(FILENAME)

BPM::XPDL->findSchemaFile(FILENAME)

$obj->importDefinitions(XMLDATA, OPTIONS)

$obj->knownNamespace(NAMESPACE|PAIRS)

BPM::XPDL->knownNamespace(NAMESPACE|PAIRS)

$obj->namespaces

$obj->printIndex([FILEHANDLE], OPTIONS)

$obj->types

$obj->walkTree(NODE, CODE)

Other

$obj->create(DATA)

    Pass a correctly constructed Perl data-structure, which maps to a xpdl:Package type, and it will produce XML for it (returns an XML::LibXML::Document object).

    Be warned that the output may contain deprecated constructs. Accidentally, the non-deprecated versions usually match better on the provided data.

    my $xml = $xpdl->create($data);
print $xml->toString(1);

DETAILS

SEE ALSO

This module is part of BPM-XPDL distribution version 0.04, built on February 20, 2010. Website: http://perl.overmeer.net

ACKNOWLEDGEMENTS

Interapy http://www.interapy.nl sponsored the development of this software.

LICENSE AND COPYRIGHT

Copyright (c) 2009-2010 by Mark Overmeer. For other contributors see ChangeLog.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See http://www.perl.com/perl/misc/Artistic.html