Apache UIMA - Source Code

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "https://www.w3.org/TR/html4/loose.dtd">    <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/> <style type="text/css">@import "stylesheets/base.css";</style> <meta name="author" value=" Apache UIMA Documentation Team"> <meta name="email" value="dev@uima.apache.org"> <title>Apache UIMA - Source Code</title> </head> <body> <div class="topLogos"> <table border="0" width="100%" cellspacing="0">  <tr> <td align='LEFT'> <a href="index.html"> <img style="border: 1px solid black;" src="./images/UIMA_banner2tlpTm.png" alt="UIMA project logo" border="0"/> </a> </td> <td align='CENTER'> <div class="pageBanner">Source Code</div> </td> <td align='RIGHT'> <a href="https://www.apache.org"> <img src="./images/asf-logo-on-white-smallTm.png" alt="Apache UIMA" border="0"/> </a> </td> </tr> </table> <hr noshade="" size="1"/> </div> <table border="0" width="100%" cellspacing="4"> <tr> <td align='RIGHT' colspan="2"> <form method="get" action="https://www.google.com/search"> Search the site <input type="text" name="q" size="25" maxlength="255" value="" /> <input type="hidden" name="sitesearch" value="https://uima.apache.org/" /> <input name="Search" value="Search Site" type="submit"/> </form> </td> </tr> <tr>  <td width="20%" valign="top">  <div class="navBar"> <br/> <div class="navBarItem"> <div class="navPartHeading">General</div> </div> <div class="navBar"> <div class="navBarItem"> <a href="./index.html">Home</a> </div> <div class="navBarItem"> <a href="./downloads.cgi">Downloads</a> </div> <div class="navBarItem"> <a href="./documentation.html">Documentation</a> </div> <div class="navBarItem"> <a href="./news.html">News</a> </div> <div class="navBarItem"> <a href="./publications.html">Publications</a> </div> <br style="line-height: .5em"/> <div class="navBarItem"> <a href="https://issues.apache.org/jira/browse/uima" target="_blank" rel="noopener">Issue tracker <img src="images/offsitelink.png"/></a> </div> <div class="navBarItem"> <a href="https://cwiki.apache.org/confluence/display/UIMA/" target="_blank" rel="noopener">Wiki <img src="images/offsitelink.png"/></a> </div> <br style="line-height: .5em"/> <div class="navBarItem"> <a href="https://cwiki.apache.org/confluence/display/UIMA/Powered+by+Apache+UIMA" target="_blank" rel="noopener">Powered By UIMA <img src="images/offsitelink.png"/></a> </div> </div> <br/> <div class="navBarItem"> <div class="navPartHeading">Community</div> </div> <div class="navBar"> <div class="navBarItem"> <a href="./get-involved.html">Get Involved</a> </div> <div class="navBarItem"> <a href="./mail-lists.html">Mailing Lists</a> </div> <div class="navBarItem"> <a href="./contribution-policy.html">Contribution Policies</a> </div> <div class="navBarItem"> <a href="./faq.html">FAQ</a> </div> <div class="navBarItem"> <a href="./project-guidelines.html">Project Guidelines</a> </div> </div> <br/> <div class="navBarItem"> <div class="navPartHeading">Components & Tools</div> </div> <div class="navBar"> <div class="navBarItem"> <a href="./sandbox.html#uima-addons-annotators">Annotators</a> </div> <div class="navBarItem"> <a href="./toolsServers.html">Tools & Servers</a> </div> <div class="navBarItem"> <a href="./sandbox.html">Addons and Sandbox</a> </div> <div class="navBarItem"> <a href="./ruta.html">UIMA Ruta</a> </div> <div class="navBarItem"> <a href="https://github.com/apache/uima-uimafit" target="_blank" rel="noopener">uimaFIT <img src="images/offsitelink.png"/></a> </div> <div class="navBarItem"> <a href="./external-resources.html">External Resources</a> </div> </div> <br/> <div class="navBarItem"> <div class="navPartHeading">Development</div> </div> <div class="navBar"> <div class="navBarItem"> <a href="./dev-quick.html">Quick Start: building</a> </div> <div class="navBarItem"> <a href="./building-uima.html">Building from Source</a> </div> <div class="navBarItem"> <a href="./one-time-setup.html">One-time setups</a> </div> <div class="navBarItem"> <a href="./svn.html">Source Code</a> </div> <div class="navBarItem"> <a href="./release.html">Doing a UIMA release</a> </div> <div class="navBarItem"> <a href="https://www.apache.org/security/committers.html" target="_blank" rel="noopener">Doing a CVE (Apache) <img src="images/offsitelink.png"/></a> </div> <div class="navBarItem"> <a href="./eclipse-update-site.html">Eclipse Update Sites</a> </div> <div class="navBarItem"> <a href="./git.html">GIT</a> </div> <div class="navBarItem"> <a href="./codeConventions.html">Code Conventions</a> </div> <div class="navBarItem"> <a href="./uima-specification.html">UIMA Specification (OASIS)</a> </div> <div class="navBarItem"> <a href="./team-list.html">Project Team</a> </div> <div class="navBarItem"> <a href="./maven-design.html">Maven Use</a> </div> <div class="navBarItem"> <a href="./updating-website.html">Updating this Website</a> </div> </div> <br/> <div class="navBarItem"> <div class="navPartHeading">Events and Conferences</div> </div> <div class="navBar"> <div class="navBarItem"> <a href="./coling14.html">COLING 2014</a> </div> <div class="navBarItem"> <a href="./gscl13.html">GSCL 2013</a> </div> <div class="navBarItem"> <a href="./iks09.html">IKS 2009</a> </div> <div class="navBarItem"> <a href="./gscl09.html">GSCL 2009</a> </div> <div class="navBarItem"> <a href="./lsm09.html">LSM 2009</a> </div> <div class="navBarItem"> <a href="./lrec08.html">LREC 2008</a> </div> <div class="navBarItem"> <a href="./gldv07.html">GLDV 2007</a> </div> </div> <br/> <div class="navBarItem"> <div class="navPartHeading">ASF</div> </div> <div class="navBar"> <div class="navBarItem"> <a href="https://www.apache.org/licenses/" target="_blank" rel="noopener">License <img src="images/offsitelink.png"/></a> </div> <div class="navBarItem"> <a href="https://www.apache.org/foundation/thanks.html" target="_blank" rel="noopener">ASF Sponsors <img src="images/offsitelink.png"/></a> </div> <div class="navBarItem"> <a href="https://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener">ASF Sponsorship <img src="images/offsitelink.png"/></a> </div> <div class="navBarItem"> <a href="./security_report">Security</a> </div> </div> </div> </td> <td width="80%" align="left" valign="top"> <div class="sectionTable"> <table class="sectionTable"> <tr><td> <a name="Apache UIMA™ Source Code"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/> Apache UIMA™ Source Code</h1></a> </td></tr> <tr><td> <blockquote class="sectionBody"> <p> <ul> <li><a href="#source.code.repository">Source Code Repository</a> <br /> </li> <li><a href="#git-projs">Using Git</a></li> <li><a href="#checkout.code">Checking Out Code Using Subversion</a> <ul> <li><a href="#anonymous.checkout">Anonymous check out from Subversion</a></li> <li><a href="#access.firewall">Access from behind a firewall</a></li> <li><a href="#access.proxy">Access through a proxy</a></li> <li><a href="#committer.access">Committer access</a></li> <li><a href="#checkout.using.eclipse">Checking Out Code using Eclipse</a></li> </ul> <br /> </li> <li><a href="#submit.code.changes">Submitting Code Changes</a> <ul> <li><a href="#submitting.patch">Submitting a patch</a></li> <li><a href="#committing.changes">Committing changes to subversion</a></li> </ul> </li> <li><a href="#source.code.repository.web.access">Web Access to Subversion</a></li>  </ul> </p> </blockquote> </p> </td></tr> </table> <div class="sectionTable"> <table class="sectionTable" id='source.code.repository'> <tr><td> <a name="Source Code Repository"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/> Source Code Repository</h1></a> </td></tr> <tr><td> <blockquote class="sectionBody"> <p>Apache UIMA uses <a class="external" rel="nofollow noopener" target="_blank" href="https://subversion.apache.org"> Subversion</a> and <a class="external" rel="nofollow noopener" target="_blank" href="https://github.com/apache"> Git</a> to manage its source code. uimaj, uimaFIT, and uima-cpp have moved to GIT, the other projects are in SVN. </p> <p> The code for UIMA is stored in several repositories:</p> <ol> <li>addons - a collection of add-ons for UIMA including annotators</li> <li>sandbox - a collection of new things for UIMA, not yet released</li> <li>uimacpp - the C++ framework supporting Annotators written in C++</li> <li>build - Build information and configurations used in building from sources</li> </ol> <p> Each of these have multiple branches: trunk or master - for the latest, tags - for preserved copies of releases, and branches for special development efforts. </p> <p> To receive notice of commits to the repository subscribe to <a href="mailto:commits@uima.apache.org"> commits@uima.apache.org</a> by sending email to <a href="mailto:commits-subscribe@uima.apache.org"> commits-subscribe@uima.apache.org</a>. </p> <h2 id="git-projs">UIMA projects in GIT</h2> <p>The UIMA projects <a class="external" rel="nofollow noopener" target="_blank" href="https://github.com/apache/uima-uimaj">uimaj</a>, <a class="external" rel="nofollow noopener" target="_blank" href="https://github.com/apache/uima-uimacpp">uimacpp</a>, and <a class="external" rel="nofollow noopener" target="_blank" href="https://github.com/apache/uima-uimafit">uimaFIT</a> are at github in the apache organization. More information on GIT use is <a rel="nofollow noopener" target="_blank" href="git.html">git.html</a>. </p> <table class="subsectionTable" id='source.code.repository.web.access'> <tr><td> <a name="Web Access to Subversion"> <h2>Web Access to Subversion </h2> </a> </td></tr> <tr><td> <blockquote class="subsectionBody"> <p>See <a href="one-time-setup.html#svn-setup">SVN setup</a> for details on how to setup SVN.</p> <p> If you just want to browse the source code in SVN, you can use the <a class="external" rel="nofollow noopener" href="https://svn.apache.org/viewvc/uima"> viewvc web interface</a> to Subversion. This is current at all times. </p> </blockquote> </td></tr> </table> </blockquote> </p> </td></tr> </table> <div class="sectionTable"> <table class="sectionTable" id='checkout.code'> <tr><td> <a name="Checking Out Code Using Subversion"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/> Checking Out Code Using Subversion</h1></a> </td></tr> <tr><td> <blockquote class="sectionBody"> <p>Anyone can check code out of Subversion. Username and password are only needed to update the Subversion repository; only UIMA committers can do that. If you are a committer, are working from behind a firewall, or are connected to the internet through a proxy server, please see the sections below for more information. </p> <table class="subsectionTable" id='anonymous.checkout'> <tr><td> <a name="Anonymous check out from Subversion"> <h2>Anonymous check out from Subversion </h2> </a> </td></tr> <tr><td> <blockquote class="subsectionBody"> <p>Use a command like:</p> <longquote><code>% svn checkout https://svn.apache.org/repos/asf/uima/uimaj/trunk</code></longquote> <p>Once you have Apache UIMA checked out you can update your working copy of the checked-out sources, to pick up any changes committed since you checked things out, by executing the following command from within the UIMA directory. </p> <longquote><code>% svn update</code></longquote> </blockquote> </td></tr> </table> <table class="subsectionTable" id='access.firewall'> <tr><td> <a name="Access from behind a firewall"> <h2>Access from behind a firewall </h2> </a> </td></tr> <tr><td> <blockquote class="subsectionBody"> <p>For those users who are behind a corporate firewall which is blocking http access to the Subversion repository, you can try to access it via HTTPS: </p> <longquote><code>% svn checkout https://svn.apache.org/repos/asf/uima/uimaj/trunk</code></longquote> </blockquote> </td></tr> </table> <table class="subsectionTable" id='access.proxy'> <tr><td> <a name="Access through a proxy"> <h2>Access through a proxy </h2> </a> </td></tr> <tr><td> <blockquote class="subsectionBody"> <p>The Subversion client can go through a proxy, if you configure it to do so. First, edit your "servers" configuration file to indicate which proxy to use. The location of this configuration file depends on your operating system. On Linux or Unix it is located in the directory "~/.subversion". On Windows it is in "%APPDATA%\Subversion". (Try "echo %APPDATA%", note this is a hidden directory.) </p> <p>There are comments in the file explaining what to do. If you don't have that file, get the latest Subversion client and run any command; this will cause the configuration directory and template files to be created. </p> <p>Example : Edit the 'servers' file and add something like : </p> <longquote><pre> [global] http-proxy-host = your.proxy.name http-proxy-port = 3128 </pre></longquote> </blockquote> </td></tr> </table> <table class="subsectionTable" id='committer.access'> <tr><td> <a name="Committer access"> <h2>Committer access </h2> </a> </td></tr> <tr><td> <blockquote class="subsectionBody"> <p>Everyone can access the Apache UIMA Subversion repository via HTTPS. Apache UIMA Committers must checkout the Subversion repository via HTTPS (not HTTP), in order to be able to check in changes. </p> <longquote><code>% svn checkout https://svn.apache.org/repos/asf/uima/uimaj/trunk</code></longquote> </blockquote> </td></tr> </table> </blockquote> </p> </td></tr> </table> <div class="sectionTable"> <table class="sectionTable" id='submit.code.changes'> <tr><td> <a name="Submitting Code Changes"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/> Submitting Code Changes</h1></a> </td></tr> <tr><td> <blockquote class="sectionBody"> <table class="subsectionTable" id='submitting.patch'> <tr><td> <a name="Submitting a patch"> <h2>Submitting a patch </h2> </a> </td></tr> <tr><td> <blockquote class="subsectionBody"> <p>If you make changes to Apache UIMA, and would like to contribute this to the project, you should open a JIRA issue and discuss the changes with the developer community. If there is agreement, create a patch and attach it to the JIRA issue. </p> <p> To create a patch, use the Eclipse Team <code>-></code> Create Patch command select the project in the Package Explorer, right click it to find the Team menu in the context menu). Or, use the command line and execute the svn diff command. This creates a patch that can easily be uploaded to a JIRA issue. A good name for the patch includes the JIRA issue name, e.g. UIMA-104.patch. If there are several patches for the same JIRA issue, you might include a short identifying description, or your initials, e.g. UIMA-104.clr.patch </p> <longquote><pre> % svn diff > UIMA-104.clr.patch </pre></longquote> </blockquote> </td></tr> </table> <table class="subsectionTable" id='committing.changes'> <tr><td> <a name="Committing changes to subversion"> <h2>Committing changes to subversion </h2> </a> </td></tr> <tr><td> <blockquote class="subsectionBody"> <p> To commit changes to the subversion repository, you must be an Apache UIMA committer. See <a href="get-involved.html">get involved</a> for information on how to become a committer and how to set up your password once you become a committer. </p> <p> Once your password is set, you can commit from Eclipse using the <code>Team -> commit</code> context menu. You can do this on an individual file, a set of files or directories (multi-select), or on whole project(s). You can also commit from the command line like this: </p> <longquote><pre> $> svn commit --username your-username \ Authentication realm: <https://svn.apache.org:443> \ ASF Committers Password for 'your-username': your-password </pre></longquote> <p>You can also pass your password on the command line directly, but this is a security problem on multiuser unix computers (the command line arguments are available via the ps command). Here is the command if you are Windows or a single user unix computer: </p> <longquote><pre> $> svn commit --username your-username \ --password your-password </pre></longquote> <p>Remember to replace 'your-username' and 'your-password' with your actual username and password on svn.apache.org. </p> <p> Please also add to your commit statement an appropriate message that explains the changes you did. You can add a message when adding <code>--message</code> to your commit statement: </p> <longquote><pre> $> svn commit --username your-username \ --password your-password --message your-message </pre></longquote> <p> Please always enter the JIRA issue key or keys (if more than one issue) and optionally, the JIRA issue link to the commit message. The issue key (e.g., UIMA-555) is important so that the JIRA SVN plugin can detect the changes automatically. Only specifying the issue link does not work correctly, for details please see the JIRA issue <a class="external" rel="nofollow noopener" href="https://jira.atlassian.com/browse/SVN-37"> https://jira.atlassian.com/browse/SVN-37</a>. </p> </blockquote> </td></tr> </table> </blockquote> </p> </td></tr> </table> </td> </tr>  <tr><td colspan="2"> <hr noshade="" size="1"/> </td></tr> <tr><td colspan="2"> <table class="pageFooter"> <tr> <td><a href="index.html">Home</a></td> <td><a href="privacy-policy.html">Privacy Policy</a></td> <td style="font-size:75%"> Copyright © 2006-2024, The Apache Software Foundation.<br/> Apache UIMA, UIMA, the Apache UIMA logo and the Apache Feather logo are trademarks of The Apache Software Foundation.<br/> All other marks mentioned may be trademarks or registered trademarks of their respective owners. </td> <td><a href="mailto:dev@uima.apache.org">Contact us</a></td> </tr> </table> </td></tr> </table> </body> </html>

CINXE.COM

Apache UIMA - Source Code