LS - Perl module for building clients and servers which resolve and perform


lsid-perl documentation  | view source Contained in the lsid-perl distribution.

Index


NAME

Top

LS - Perl module for building clients and servers which resolve and perform metadata queries on LSIDs.

SYNOPSIS

Top

 use LS::ID;
 use LS::Locator;

 $lsid = LS::ID->new(
    'urn:lsid:biomoby.org:servicetype:Retrieval:2001-09-21T16-00-00Z'
     );

 $locator = LS::Locator->new();
 $authority = $locator->resolveAuthority($lsid);

 $resource = $authority->getResource($lsid);

 $data = $resource->getData();

 $response = $data->response();

 # $response is a filehandle, so you can use it as with any other

 print <$response>;




DESCRIPTION

Top

The LS module is used for building clients and servers which resolve LSIDs and perform metadata queries on LSIDs. More information on LSIDs can be found at http://www.omg.org/cgi-bin/doc?dtc/04-05-01

makeAccessorMethods( $methodList, $package )

 Creates default accessor methods for an array ref of method names
 in the package specified by $package

SEE ALSO

Top

LS::ID, LS::Locator, LS::Authority, LS::Resource, LS::Service, LS::SOAP::Service, LS::HTTP::Service, http://www.omg.org/cgi-bin/doc?dtc/04-05-01, http://oss.software.ibm.com/developerworks/projects/lsid

AUTHOR

Top

IBM

COPYRIGHT AND LICENSE

Top

NAME

Top

LS::Base - This package is the base package that all other LS packages inherit from.

VARIABLES

Top

A list of variables used in this package.

$_ERR

 Package error string.

$_STACK_TRACE

 Holds the Carp stack traces

appendError( $extraMessage )

 Appends additional information to the error string
 Parameters - $extraMessage, Required. The additional information to store.

recordError( $errorMessage ) - Records the message in the class's error string

 Parameters - $errorMessage, Required. The message to be stored in the class's
 rror string.

addStackTrace( )

 Appends a Carp stack trace to the error string

getStackTrace( )

 Retrieves a copy (in the form of an arrayref) of the 
 stack traces associated with this object.

 Returns - An arrayref that is a COPY of the arrayref containing
 all of the stack traces.

hasStackTrace( )

 Determins whether or not a stack trace is present

 Returns - True if there is a stack trace
 		   False / undef if no stack trace is available
=cut

sub hasStackTrace {

	my $self = shift;

	if($self && ref $self) {

		return (scalar(@{ $self->{'_stack_trace'} } > 0) );
	}
	else {

		return (scalar(@{ $_STACK_TRACE }) > 0);
	}
}




clearStackTrace( )

 Clears the stack trace

errorString( )

 Returns one of two error strings:

 1. if the class has been blessed in to a reference, the internal
 class error string is returned.
 2. if the class has not been blessed in to a reference, the package
 error string is returned.

 These values may be undef if no error has occured.

error_string( )

 Synonym for errorString

errorDetails( )

 Returns the complete error with all applicable 
 stack traces.

 Returns - A very detailed error message

SEE ALSO

Top

LS::ID, LS::Locator, LS::Authority, LS::Resource, LS::Service, LS::SOAP::Service, LS::HTTP::Service, http://www.omg.org/cgi-bin/doc?dtc/04-05-01, http://oss.software.ibm.com/developerworks/projects/lsid

AUTHOR

Top

IBM

COPYRIGHT AND LICENSE

Top


lsid-perl documentation  | view source Contained in the lsid-perl distribution.