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().

Extends "DESCRIPTION" in XML::Compile::Cache.

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

Extends "METHODS" in XML::Compile::Cache.

Constructors

Extends "Constructors" in XML::Compile::Cache.

$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');

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   'ATTEMPT'
 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   []
 parser_options      XML::Compile          <many>
 prefix_keys                               <true>
 prefixes            XML::Compile::Cache   <smart>
 schema_dirs         XML::Compile          undef
 typemap             XML::Compile::Cache   {}
 xsi_type            XML::Compile::Cache   {}

allow_undeclared => BOOLEAN
any_element => CODE|'TAKE_ALL'|'SKIP_ALL'|'ATTEMPT'|'SLOPPY'
block_namespace => NAMESPACE|TYPE|HASH|CODE|ARRAY
hook => HOOK|ARRAY
hooks => ARRAY
ignore_unused_tags => BOOLEAN|REGEXP
key_rewrite => HASH|CODE|ARRAY
opts_readers => HASH|ARRAY-of-PAIRS
opts_rw => HASH|ARRAY-of-PAIRS
opts_writers => HASH|ARRAY-of-PAIRS
parser_options => HASH|ARRAY
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|ARRAY
xsi_type => HASH|ARRAY

Accessors

Extends "Accessors" in XML::Compile::Cache.

$obj->addHook($hook|LIST|undef): Inherited, see "Accessors" in XML::Compile::Schema
$obj->addHooks( $hook, [$hook, ...] ): Inherited, see "Accessors" in XML::Compile::Schema
$obj->addKeyRewrite($predef|CODE|HASH, ...): Inherited, see "Accessors" in XML::Compile::Schema
$obj->addSchemaDirs(@directories|$filename)
BPM::XPDL->addSchemaDirs(@directories|$filename): Inherited, see "Accessors" in XML::Compile
$obj->addSchemas($xml, %options): Inherited, see "Accessors" in XML::Compile::Schema
$obj->addTypemap(PAIR): Inherited, see "Accessors" in XML::Compile::Schema
$obj->addTypemaps(PAIRS): Inherited, see "Accessors" in XML::Compile::Schema
$obj->addXsiType( [HASH|ARRAY|LIST] ): Inherited, see "Accessors" in XML::Compile::Cache
$obj->allowUndeclared( [BOOLEAN] ): Inherited, see "Accessors" in XML::Compile::Cache
$obj->anyElement('ATTEMPT'|'SLOPPY'|'SKIP_ALL'|'TAKE_ALL'|CODE): Inherited, see "Accessors" in XML::Compile::Cache
$obj->blockNamespace($ns|$type|HASH|CODE|ARRAY): Inherited, see "Accessors" in XML::Compile::Schema
$obj->hooks( [<'READER'|'WRITER'>] ): Inherited, see "Accessors" in XML::Compile::Schema
$obj->namespace()
$obj->typemap( [HASH|ARRAY|PAIRS] ): Inherited, see "Accessors" in XML::Compile::Cache
$obj->useSchema( $schema, [$schema, ...] ): Inherited, see "Accessors" in XML::Compile::Schema
$obj->version()

Prefix management

Extends "Prefix management" in XML::Compile::Cache.

$obj->addNicePrefix(BASE, NAMESPACE): Inherited, see "Prefix management" in XML::Compile::Cache
$obj->addPrefixes( [PAIRS|ARRAY|HASH] ): Inherited, see "Prefix management" in XML::Compile::Cache
$obj->learnPrefixes($node): Inherited, see "Prefix management" in XML::Compile::Cache
$obj->prefix($prefix): Inherited, see "Prefix management" in XML::Compile::Cache
$obj->prefixFor($uri): Inherited, see "Prefix management" in XML::Compile::Cache
$obj->prefixed( $type|<$ns,$local> ): Inherited, see "Prefix management" in XML::Compile::Cache
$obj->prefixes( [$params] ): Inherited, see "Prefix management" in XML::Compile::Cache

Compilers

Extends "Compilers" in XML::Compile::Cache.

$obj->addCompileOptions( ['READERS'|'WRITERS'|'RW'], %options ): Inherited, see "Compilers" in XML::Compile::Cache
$obj->compile( <'READER'|'WRITER'>, $type, %options ): Inherited, see "Compilers" in XML::Compile::Schema
$obj->compileAll( ['READERS'|'WRITERS'|'RW', [$ns]] ): Inherited, see "Compilers" in XML::Compile::Cache
$obj->compileType( <'READER'|'WRITER'>, $type, %options ): Inherited, see "Compilers" in XML::Compile::Schema
$obj->dataToXML($node|REF-XML|XML-STRING|$filename|$fh|$known)
BPM::XPDL->dataToXML($node|REF-XML|XML-STRING|$filename|$fh|$known): Inherited, see "Compilers" in XML::Compile
$obj->initParser(%options)
BPM::XPDL->initParser(%options): Inherited, see "Compilers" in XML::Compile
$obj->reader($type|$name, %options): Inherited, see "Compilers" in XML::Compile::Cache
$obj->template( <'XML'|'PERL'|'TREE'>, $element, %options ): Inherited, see "Compilers" in XML::Compile::Schema
$obj->writer($type|$name): Inherited, see "Compilers" in XML::Compile::Cache

Administration

Extends "Administration" in XML::Compile::Cache.

$obj->declare( <'READER'|'WRITER'|'RW'>, <$type|ARRAY>, %options ): Inherited, see "Administration" in XML::Compile::Cache
$obj->doesExtend($exttype, $basetype): Inherited, see "Administration" in XML::Compile::Schema
$obj->elements(): Inherited, see "Administration" in XML::Compile::Schema
$obj->findName($name): Inherited, see "Administration" in XML::Compile::Cache
$obj->findSchemaFile($filename)
BPM::XPDL->findSchemaFile($filename): Inherited, see "Administration" in XML::Compile
$obj->importDefinitions($xmldata, %options): Inherited, see "Administration" in XML::Compile::Schema
$obj->knownNamespace($ns|PAIRS)
BPM::XPDL->knownNamespace($ns|PAIRS): Inherited, see "Administration" in XML::Compile
$obj->namespaces(): Inherited, see "Administration" in XML::Compile::Schema
$obj->printIndex( [$fh], %options ): Inherited, see "Administration" in XML::Compile::Cache
$obj->types(): Inherited, see "Administration" in XML::Compile::Schema
$obj->walkTree($node, CODE): Inherited, see "Administration" in XML::Compile

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

Extends "DETAILS" in XML::Compile::Cache.

DESCRIPTIONS

Extends "DESCRIPTIONS" in XML::Compile::Cache.

ACKNOWLEDGEMENTS

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

LICENSE AND COPYRIGHT

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

To install BPM::XPDL, copy and paste the appropriate command in to your terminal.

cpanm

cpanm BPM::XPDL

CPAN shell

perl -MCPAN -e shell
install BPM::XPDL

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)