View Javadoc

1   /*
2    * $Id: IOWLProject.java,v 1.8 2005/06/01 17:38:38 jlerner Exp $
3    *
4    * Copyright (c) 1999-2004, BBN Technologies, LLC.
5    * All rights reserved.
6    * http://www.daml.org/legal/opensource/bbn_license.html
7    */
8   
9   package com.bbn.swede.core;
10  
11  import org.eclipse.core.resources.IContainer;
12  import org.eclipse.core.resources.IProject;
13  
14  /***
15   * Protocol specific to OWL project elements.
16   * @author jlerner
17   * @author tself
18   */
19  public interface IOWLProject extends IOWLElement
20  {
21     /***
22      * Returns the Eclipse project resource that is the basis for this OWL
23      * project.
24      * @return The project's inner IProject.
25      */
26     IProject getProject();
27  
28     /***
29      * <p>Returns the Eclipse project resource that is the basis for this OWL
30      * project, cast as an IContainer.</p>
31      * 
32      * <p>This is a convenience method, fully equivalent to:
33      * <blockquote>(IContainer)getProject()</blockquote></p>
34      * @return The project's inner IProject, cast as an IContainer.
35      */
36     IContainer getContainer();
37  
38     /***
39      * Searches the project for a document with a specific base URI.
40      * @param sURI URI of the document to locate
41      * @return An IOWLDocument matching the specified URI, or <code>null</code>
42      *         if the project does not contain the requested document.
43      */
44     IOWLDocument getDocument(String sURI);
45  }