NAME

XML::ASCX12::Catalogs - Catalog Looping Rules for ASCX12 EDI Data

DESCRIPTION

This defines how the loops are constructed per catalog. By catalog we mean EDI transaction set.

The 0 catalog is the general relationship for ASCX12. It say that the parent loop ISA can have GS child loops. Also, GS child loops can have ST child loops. This one shouldn't have to change.

To include additional catalogs, use the pattern and enclose in the conditional structure.

PUBLIC STATIC VARIABLES

$LOOPNEST

This is a reference to an array hash. The array contains the looping rules on a per-catalog basis.

$IS_CHILD

This is a reference to a hash of hashes. It is not used with all Catalogs. The hash contains all the the parent (current loop) and child (next segment) loop rules on a per-catalog basis. Returns one of three possible values:

  Undef - exit current loop (next segment not valid child)
  True (1) - segment is valid child for current loop 
  false (0) - segment begins new loop within current loop

The false response corresponds to the $LOOPNEST functionality. But some Catalogs can create loop patterns that $LOOPNEST alone was unable to unravel. Leaving $IS_CHILD undefined will default to using just $LOOPNEST. =back

PUBLIC STATIC METHODS

void = load_catalog($catalog_number)

This is a static public method that loads the $LOOPNEST reference with the appropiate catalog relationship data. It is called by XML-ASCX12.

To add additional catalogs, follow the same pattern. If you do add catalogs, please submit this file and the Segments.pl to the author(s) so we can make this library grow.

AUTHORS

Brian Kaney <brian@vermonster.com>, Jay Powers <jpowers@cpan.org>

http://www.vermonster.com/

Copyright (c) 2004 Vermonster LLC. All rights reserved.

This library is free software. You can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

Basically you may use this library in commercial or non-commercial applications. However, If you make any changes directly to any files in this library, you are obligated to submit your modifications back to the authors and/or copyright holder. If the modification is suitable, it will be added to the library and released to the back to public. This way we can all benefit from each other's hard work!

If you have any questions, comments or suggestions please contact the author.

SEE ALSO

XML::ASCX12 and XML::ASCX12::Segments