1   /*
2    *  GateConstants.java
3    *
4    *  Copyright (c) 1998-2004, The University of Sheffield.
5    *
6    *  This file is part of GATE (see http://gate.ac.uk/), and is free
7    *  software, licenced under the GNU Library General Public License,
8    *  Version 2, June 1991 (in the distribution as file licence.html,
9    *  and also available at http://gate.ac.uk/gate/licence.html).
10   *
11   *  Cristian URSU, 8/Nov/2001
12   *
13   *  $Id: GateConstants.java,v 1.25 2004/07/21 17:34:56 valyt Exp $
14   */
15  
16  package gate;
17  
18  /** Interface used to hold different GATE constants */
19  public interface GateConstants {
20  
21    /** The name of config data files (<TT>gate.xml</TT>). */
22    public static final String GATE_DOT_XML = "gate.xml";
23  
24    /** The name of session state data files (<TT>gate.session</TT>). */
25    public static final String GATE_DOT_SER = "gate.session";
26  
27    /** The name of the site config property (<TT>gate.config</TT>). */
28    public static final String GATE_CONFIG_PROPERTY = "gate.config";
29  
30    /** The name of the annotation set storing original markups in a document */
31    public static final String
32      ORIGINAL_MARKUPS_ANNOT_SET_NAME = "Original markups";
33  
34  
35    /** The look and feel option name*/
36    public static final String LOOK_AND_FEEL = "Look_and_Feel";
37  
38    /** The key for the font used for text components*/
39    public static final String TEXT_COMPONENTS_FONT = "Text_components_font";
40  
41    /** The key for the font used for menus*/
42    public static final String MENUS_FONT = "Menus_font";
43  
44    /** The key for the font used for other GUI components*/
45    public static final String OTHER_COMPONENTS_FONT = "Other_components_font";
46  
47    /** The key for the main window width*/
48    public static final String MAIN_FRAME_WIDTH = "Main_frame_width";
49  
50    /** The key for the main window height*/
51    public static final String MAIN_FRAME_HEIGHT = "Main_frame_height";
52  
53    /** The key for the save options on exit value*/
54    public static final String SAVE_OPTIONS_ON_EXIT = "Save_options_on_exit";
55  
56    /** The key for the save session on exit value*/
57    public static final String SAVE_SESSION_ON_EXIT = "Save_session_on_exit";
58  
59    /** The key for saving the features when preserving format*/
60    public static final String SAVE_FEATURES_WHEN_PRESERVING_FORMAT =
61      "Save_features_when_preserving_format";
62  
63    /**
64     * The key for the known plugins path option
65     */
66    public static final String KNOWN_PLUGIN_PATH_KEY = "Known_plugin_path";
67    
68    /**
69     * The key for the autoload plugins path option
70     */
71    public static final String LOAD_PLUGIN_PATH_KEY = "Load_plugin_path";
72    
73    /**
74     * The key for the autoload plugins path system property
75     */
76    public static final String LOAD_PLUGIN_PATH_SYSPROP_KEY = "load.plugin.path";
77  
78    /**
79     * The key for the GATE_HOME system property
80     */
81    public static final String GATE_HOME_SYSPROP_KEY = "gate.home";
82  
83    
84    /** The key for the feature keeping the original content of the document */
85    public static final String
86     ORIGINAL_DOCUMENT_CONTENT_FEATURE_NAME = "Original_document_content_on_load";
87  
88    /** The key for the feature keeping the repositioning information
89     *  between original and displayed content of the document*/
90    public static final String
91      DOCUMENT_REPOSITIONING_INFO_FEATURE_NAME = "Document_repositioning_info";
92  
93    /** */
94    public static final String
95      DOCUMENT_ADD_SPACE_ON_UNPACK_FEATURE_NAME = "Document_add_space_on_unpack";
96  
97    /** Property to set title of application from command line */
98    public static final String TITLE_JAVA_PROPERTY_NAME = "gate.slug.title";
99  
100   /** Property to set icon of application from command line */
101   public static final String APP_ICON_JAVA_PROPERTY_NAME = "gate.slug.icon";
102 
103   /** Property to set splash of application from command line */
104   public static final String APP_SPLASH_JAVA_PROPERTY_NAME = "gate.slug.splash";
105 
106   /** Property to set help about box from command line */
107   public static final String ABOUT_URL_JAVA_PROPERTY_NAME = "gate.slug.abouturl";
108 
109   /** Property to set slug application from command line */
110   public static final String APPLICATION_JAVA_PROPERTY_NAME = "gate.slug.app";
111 
112   /** Property to set slug annotation types for export Inline */
113   public static final String ANNOT_TYPE_TO_EXPORT = "annotTypesToExport";
114 
115   /** The key for the feature keeping the IndexDefinition*/
116   public static final String
117     CORPUS_INDEX_DEFINITION_FEATURE_KEY = "Index_definition_feature_key";
118 
119   /** The key for the feature keeping the IndexStatistics*/
120   public static final String
121     CORPUS_INDEX_STATISTICS_FEATURE_KEY = "Index_statistics_feature_key";
122 
123   /** The key used for document editor inser behaviour */
124   public static final String DOCEDIT_INSERT_APPEND = "docedit_insert_append";
125 
126   /** The key used for document editor inser behaviour */
127   public static final String DOCEDIT_INSERT_PREPEND = "docedit_insert_prepend";
128 
129   /** Document property to set throw of exception on parsing format error */
130   public static final String THROWEX_FORMAT_PROPERTY_NAME =
131     "throwExceptionOnFormatError";
132 
133   /** The key for the WordNet config file*/
134   public static final String WORDNET_CONFIG_FILE = "Wordnet_config_file";
135 
136 //  /** The index type of corpus*/
137 //  public static final int IR_LUCENE_INVFILE = 1001;
138 
139   /** Property for document new line type. Values {"CR", "LF", "CRLF", "LFCR"}*/
140   public static final String DOCUMENT_NEW_LINE_TYPE = "docNewLineType";
141 
142 } // GateConstants