CaCORE
1 match

 view release on metacpan or  search on metacpan

html/intro.html  view on Meta::CPAN 

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

<html>

<head>
<title>Introduction to CaCOREperl</title>
</head>

<body>

<h1>Contents</h1>
<ul>
  <li><a class="doc" href="#What_is_CaCOREperl">What is CaCOREperl</a></li>
  <li><a class="doc" href="#installing">Installing CaCOREperl</a></li>
  <li><a class="doc" href="#Using_CaCOREperl">Getting Started</a></li>
  <li><a class="doc" href="#Object_Desc">Object Descriptions</a></li>
  <li><a class="doc" href="searching.html">Search</a></li>
  <li><a class="doc" href="#limitations">Limitations</a></li>
  <li><a class="doc" href="#Troubleshooting_FAQ">More Information</a></li>
</ul>

<h2><a name="What_is_CaCOREperl">What is CaCOREperl?</a></h2>

<p>CaCOREperl is a Perl application programming interface to caCORE hosted vocabulary,
metadata, and biomedical data. It implements the caCORE object model with object-oriented
methodology, and encapsulates webservice invocations and XML parsing so that programmers deal with caCORE
objects directly. CaCOREperl is available in Windows, Solaris and other Perl
supported operating systems<br>
CaCOREperl requires Perl version 5.6.0 or above.<br>
Current version of CaCOREperl is 3.2.

<h3>Main Features of CaCOREperl:</h3>
<ul>
  <li>search caCORE server, a Java application, hosted vocabulary, metadata, and biomedical data</li>
  <li>manipulate search results in object oriented fashion
  <li>association navigation from object to object</li>
</ul>

<h3>CaCOREperl contains the following sub-packages:</h3>
<ul>
  <li>CaBIO</li>
  <li>CaMOD (Deprecated)</li>
  <li>CaDSR</li>
  <li>EVS</li>
  <li>Common</li>
</ul>

<h3>Architecture</h3>
<p>The following picture describe the architecture of CaCOREperl and how it is related to the caCORE server.</p>
<IMG src="architecture.jpg"</IMG>

<p>This picture illustrates the following features of CaCOREperl:<p>

<ul>
	<li>CaCOREperl itself is not a data store, but a delegate to the caCORE server.
	<li>CaCOREperl encapsulates the gory details of webservice call to the caCORE server, and serializing/deserializing
	of domain objects.
	<li>Communication with caCORE server is transparent to the user.
</ul>

<h2><a name="installing">Installing CaCOREperl</a></h2>

Perl comes installed on Unix and Linux platforms. For window based systems, you can download
a Perl version from www.activestate.com.

CaCOREperl is depened on two Perl modules, XML::DOM and LWP::UserAgent.
You must install both XML::DOM and LWP::UserAgent in addition to CaCOREperl.

<p>There are multiple ways to installing Perl modules, the following are three of them.</p>

<h3>Using make</h3>
<p>First unzip the CaCORE to a temporary folder. Then open a Command window,
cd to the directory that contains this README file and type the following.<br/>
<DD>
<code>perl Makefile.PL</code><br/>
</DD>

Alternatively, if you plan to install CaCORE somewhere other than
your system's perl library directory. You can type something like this:<br/>
<DD>
<code>perl Makefile.PL PREFIX=/home/me/perl INSTALLDIRS=perl</code><br/>
</DD>

Then to build you run make.<br/>
<DD>
<code>make</code><br/>
</DD>

You can then test the module by typing:<br/>
<DD>
<code>make test</code><br/>
</DD>

If you have write access to the perl library directories, you may then install by typing:<br/>
<DD>
<code>make install</code><br/>
</DD>

<h3>Using Perl Package Manager (PPM)</h3>
Perl Package Manager (PPM) is a tool that comes with the ActiveState Perl installation. It can be used to manage your
Perl packages.

After installing ActiveState Perl, you can start PPM (depends on the version, this can be done through the Start->Programs->ActiveState Perl, or from a command prompt, cd to the <your Perl folder>\bin, and run ppm). This will bring up a command promp...
<DD>
<code>install XML-DOM</code><br/>
</DD>
This will install the XML::DOM module on your PC.

<h3>Using CPAN</h3>
<p>This will work on any platform, any Perl version. Run the command:<br/>
<DD>
<code>perl -MCPAN -e shell</code><br/>
</DD>
Refer to the <a href=http://www.perldoc.com/perl5.6/lib/CPAN.html>CPAN documentation</a> for more details on how to
use this command.

<h3>Manual installation</h3>
<p>This is only recommended if all else failed. You can unzip this distribution, and copy the entire CaCORE folder under the



( run in 1.534 second using v1.01-cache-2.11-cpan-39bf76dae61 )