View Javadoc

1   /*
2    * $Id: ISuggestionCandidate.java,v 1.4 2005/02/28 22:39:40 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.editor.contentassist;
10  
11  /***
12   * An element name and an element type generated by NamespaceSuggesters
13   * for use by ContentAssistProcessors.  
14   * 
15   * @author aperezlo
16   */
17  public interface ISuggestionCandidate extends Comparable
18  {
19     /***
20      * <code>UNKNOWN</code> represents that the type of suggestion is unknown.
21      */
22     int UNKNOWN = 1;
23     /***
24      * <code>NAMESPACE</code> represents that the type of suggestion is that of a namespace.
25      */
26     int NAMESPACE = 2;
27     /***
28      * <code>ELEMENT</code> represents that the type of suggestion is a named individual.
29      */
30     int ELEMENT = 4;
31     /***
32      * <code>ATTRIBUTE</code> represents that the type of suggestion is an attribute.
33      */
34     int ATTRIBUTE = 8;
35     /***
36      * <code>CLASS</code> represents that the type of suggestion is an OWL class.
37      */
38     int CLASS = 16;
39     /***
40      * <code>PROPERTY</code> represents that the type of suggestion is an OWL property.
41      */
42     int PROPERTY = 32;
43     
44     /***
45      * Retrieves the suggestion candidate's type.
46      * @return the name of this suggestion
47      */
48     int getType();
49     /***
50      * Retrieves the suggestion candidate's name.
51      * @return the type of this suggestion, as defined by the constants defined in this interface
52      */
53     String getName();
54     
55     
56  }