NAME

JSAN::Index - JavaScript Archive Network (JSAN) SQLite/CDBI Index

DESCRIPTION

JSAN is the JavaScript Archive Network, a port of CPAN to JavaScript.

You can find the JSAN at http://openjsan.org.

As well as a flat text file index like CPAN, the JSAN index is also distributed as a DBD::SQLite database.

JSAN::Index is a Class::DBI wrapper built around the JSAN SQLite index.

It allow you to easily do all sorts of nifty things with the index in a simple and straight forward way.

Using The JSAN Index / Terminology

Once loaded, most of the functionality of the index is accessed through the classes that implement the various objects in the index.

These are:

JSAN::Index::Author

An author is a single human (or under certain very special circumstances a company or mailing list) that creates distributions and uploads them to the JSAN.

JSAN::Index::Distribution

A distribution is a single software component that may go through a number of releases

JSAN::Index::Release

A release is a compressed archive file containing a single version of a paricular distribution.

JSAN::Index::Library

A library is a single class, or rather a "pseudo-namespace", that defines an interface to provide some functionality. Distributions often contain a number of libraries, making up a complete "API".

METHODS

There are only a very limited number of utility methods available directly from the JSAN::Index class itself.

dependency param => $value

The dependency method creates and returns an dependency resolution object that is used by JSAN::Client to schedule which releases to install.

If the optional parameter 'build' is true, creates a build-time dependency resolve, which will additionally install releases only needed for testing.

Returns an Algorithm::Dependency object.

SUPPORT

Bugs should be reported via the CPAN bug tracker at

http://rt.cpan.org/NoAuth/ReportBug.html?Queue=JSAN-Client

For other issues, contact the author.

AUTHOR

Adam Kennedy <cpan@ali.as>, http://ali.as/

COPYRIGHT

Copyright 2005, 2006 Adam Kennedy. All rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

The full text of the license can be found in the LICENSE file included with this module.