The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
ClearCase-Tools-0.01
/ MultiSite::File::ShippingOrder

NAME

MultiSite::File::ShippingOrder - A simple parser for the MultiSite Shipping Order file

VERSION

This document describes version 0.01, released June, 2004.

SYNOPSIS

use MultiSite::File::ShippingOrder;

$shiporder = new MultiSite::File::ShippingOrder( $shipOrderFile );

$shiporder->stat and die $shiporder->err;

$count = $shiporder->count('VARIABLE');       # zero-based count

$arrayRef = $shiporder->getList('VARIABLE');
(@values) = $shiporder->getList('VARIABLE');

$shiporder->parseDate( $dateEntry );
$shiporder->parsePath( $pathEntry );
$shiporder->parseArrivalRoute( $arrivalEntry );

$hashRef = $shiporder->analyzeDeliveries;
print $shipObj->formatDeliveries( $hashRef );

$hashRef = $shipObj->analyzeFailedAttempts;
print $shipObj->formatFailedAttempts( $hashRef );

print $shiporder->dump;

DESCRIPTION

This class is an object oriented wrapper for a 'Shipping Order' file containing packet-specific details in Rational Software's MultiSite (ClearCase) environment.

Constructor

new ( ShipOrderFile )

Load a MultiSite shipping order file into memory. It's location depends on the installed version of ClearCase/MultiSite.

use MultiSite::File::ShippingOrder;

$shiporder = new MultiSite::File::ShippingOrder( $fileName );
parseDate
parsePath
parseArrivalRoute

These methods are defined to parse specific entries from a given section within a shipping order file.

ToDo: Complete this discussion.

$shiporder->parseDate( $dateEntry );

$shiporder->parsePath( $pathEntry );

$shiporder->parseArrivalRoute( $arrivalEntry );
analyzeDeliveries
formatDeliveries ( HashRef )

These methods are used to analyze and format information pertaining to SUCCESSFUL deliveries of the data packet associated with the current shipping order.

The analyzeDeliveries method returns the HashRef required by the formatDeliveries method.

$hashRef = $shiporder->analyzeDeliveries;

print $shipObj->formatDeliveries( $hashRef );
analyzeFailedAttempts
formatFailedAttempts ( HashRef )

These methods are used to analyze and format information pertaining to FAILED deliveries of the data packet associated with the current shipping order.

The analyzeFailedAttempts method returns the HashRef required by the formatFailedAttempts method.

$hashRef = $shipObj->analyzeFailedAttempts;

print $shipObj->formatFailedAttempts( $hashRef );
getList
count
stat
err
dump

These methods are defined in the parent class. See ClearCase::Vob::Info::InfoBase.

WARNING

This class supports but DOES NOT enforce syntax in the MultiSite shipping order file. Take care to ensure that assumptions made herein remain accurate! Caveat Programmer.

INHERITANCE

This class inherits from the MultiSite::Vob::Info::InfoBase class which inherits from the ClearCase::Vob::Info::InfoBase class.

SEE ALSO

See MultiSite::Vob::Info::InfoBase and ClearCase::Vob::Info::InfoBase.

AUTHOR

Chris Cobb, <chris@ccobb.net>

COPYRIGHT

Copyright (c) 2004 by Hewlett-Packard. All rights reserved. This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.