GateConstants.java
001 /*
002  * GateConstants.java
003  
004  * Copyright (c) 1995-2012, The University of Sheffield. See the file
005  * COPYRIGHT.txt in the software or at http://gate.ac.uk/gate/COPYRIGHT.txt
006  
007  * This file is part of GATE (see http://gate.ac.uk/), and is free software,
008  * licenced under the GNU Library General Public License, Version 2, June 1991
009  * (in the distribution as file licence.html, and also available at
010  * http://gate.ac.uk/gate/licence.html).
011  
012  * Cristian URSU, 8/Nov/2001
013  
014  * $Id: GateConstants.java 18850 2015-08-04 14:44:01Z domrout $
015  */
016 package gate;
017 
018 /** Interface used to hold different GATE constants */
019 public interface GateConstants {
020   /** The name of config data files (<TT>gate.xml</TT>). */
021   public static final String GATE_DOT_XML = "gate.xml";
022 
023   /** The name of the installed plug-ins directory */
024   public static final String PLUGINS = "plugins";
025 
026   /** The name of session state data files (<TT>gate.session</TT>). */
027   public static final String GATE_DOT_SER = "gate.session";
028 
029   /** The name of the site config property (<TT>gate.config</TT>). */
030   public static final String GATE_CONFIG_PROPERTY = "gate.config";
031 
032   /** The name of the annotation set storing original markups in a document */
033   public static final String ORIGINAL_MARKUPS_ANNOT_SET_NAME =
034       "Original markups";
035 
036   /** The look and feel option name */
037   public static final String LOOK_AND_FEEL = "Look_and_Feel";
038 
039   /** The key for the font used for text components */
040   public static final String TEXT_COMPONENTS_FONT = "Text_components_font";
041 
042   /** The key for the font used for menus */
043   public static final String MENUS_FONT = "Menus_font";
044 
045   /** The key for the font used for other GUI components */
046   public static final String OTHER_COMPONENTS_FONT = "Other_components_font";
047 
048   /** The key for the main window width */
049   public static final String MAIN_FRAME_WIDTH = "Main_frame_width";
050 
051   /** The key for the main window height */
052   public static final String MAIN_FRAME_HEIGHT = "Main_frame_height";
053 
054   /** The toolbar text option name */
055   public static final String TOOLBAR_TEXT = "Toolbar_Text";
056 
057   /** The key for determining if the main window should be maximized **/
058   public static final String MAIN_FRAME_MAXIMIZED = "Main_frame_maximized";
059 
060   /** The key for the save options on exit value */
061   public static final String SAVE_OPTIONS_ON_EXIT = "Save_options_on_exit";
062 
063   /** The key for the save session on exit value */
064   public static final String SAVE_SESSION_ON_EXIT = "Save_session_on_exit";
065 
066   /** The key for saving the features when preserving format */
067   public static final String SAVE_FEATURES_WHEN_PRESERVING_FORMAT =
068       "Save_features_when_preserving_format";
069 
070   /**
071    * The key for the known plugins path option in the GATE config map
072    */
073   public static final String KNOWN_PLUGIN_PATH_KEY = "Known_plugin_path";
074 
075   /**
076    * The key for the autoload plugins path option in the GATE config map
077    */
078   public static final String AUTOLOAD_PLUGIN_PATH_KEY = "Load_plugin_path";
079 
080   /**
081    * The name for the autoload plugins path system property
082    */
083   public static final String AUTOLOAD_PLUGIN_PATH_PROPERTY_NAME =
084       "load.plugin.path";
085 
086   /**
087    * The name of the GATE home system property
088    */
089   public static final String GATE_HOME_PROPERTY_NAME = "gate.home";
090 
091   /**
092    * The name of the GATE plugins home system property
093    */
094   public static final String PLUGINS_HOME_PROPERTY_NAME = "gate.plugins.home";
095 
096   /**
097    * The name of the GATE site config system property
098    */
099   public static final String SITE_CONFIG_PROPERTY_NAME = "gate.site.config";
100 
101   /**
102    * The name of the GATE user config system property
103    */
104   public static final String USER_CONFIG_PROPERTY_NAME = "gate.user.config";
105 
106   /**
107    * The name of the GATE site config system property
108    */
109   public static final String GATE_SITE_CONFIG_PROPERTY_NAME =
110       "gate.site.config";
111 
112   /**
113    * The name of the GATE user config system property
114    */
115   public static final String GATE_USER_CONFIG_PROPERTY_NAME =
116       "gate.user.config";
117 
118   /**
119    * The name of the property for setting the user session file name
120    */
121   public static final String GATE_USER_SESSION_PROPERTY_NAME =
122       "gate.user.session";
123 
124   /**
125    * The name of the built-in creole directory URL property
126    */
127   public static final String BUILTIN_CREOLE_DIR_PROPERTY_NAME =
128       "gate.builtin.creole.dir";
129 
130   /** The key for the feature keeping the original content of the document */
131   public static final String ORIGINAL_DOCUMENT_CONTENT_FEATURE_NAME =
132       "Original_document_content_on_load";
133 
134   /**
135    * The key for the feature keeping the repositioning information between
136    * original and displayed content of the document
137    */
138   public static final String DOCUMENT_REPOSITIONING_INFO_FEATURE_NAME =
139       "Document_repositioning_info";
140 
141   /** */
142   public static final String DOCUMENT_ADD_SPACE_ON_UNPACK_FEATURE_NAME =
143       "Document_add_space_on_unpack";
144 
145   /** Property to set title of application from command line */
146   public static final String TITLE_JAVA_PROPERTY_NAME = "gate.slug.title";
147 
148   /** Property to set icon of application from command line */
149   public static final String APP_ICON_JAVA_PROPERTY_NAME = "gate.slug.icon";
150 
151   /** Property to set splash of application from command line */
152   public static final String APP_SPLASH_JAVA_PROPERTY_NAME = "gate.slug.splash";
153 
154   /** Property to set help about box from command line */
155   public static final String ABOUT_URL_JAVA_PROPERTY_NAME =
156       "gate.slug.abouturl";
157 
158   /** Property to set slug application from command line */
159   public static final String APPLICATION_JAVA_PROPERTY_NAME = "gate.slug.app";
160 
161   /** Property to set slug annotation types for export Inline */
162   public static final String ANNOT_TYPE_TO_EXPORT = "annotTypesToExport";
163 
164   /** The key for the feature keeping the IndexDefinition */
165   public static final String CORPUS_INDEX_DEFINITION_FEATURE_KEY =
166       "Index_definition_feature_key";
167 
168   /** The key for the feature keeping the IndexStatistics */
169   public static final String CORPUS_INDEX_STATISTICS_FEATURE_KEY =
170       "Index_statistics_feature_key";
171 
172   /** The key used for document editor inser behaviour */
173   public static final String DOCEDIT_INSERT_APPEND = "docedit_insert_append";
174 
175   /** The key used for document editor inser behaviour */
176   public static final String DOCEDIT_INSERT_PREPEND = "docedit_insert_prepend";
177 
178   public static final String DOCEDIT_READ_ONLY = "docedit_read-only";
179 
180   /**
181    * Orientation of the document from right to left
182    */
183   public static final String DOC_RTOL_ORIENTATION = "doc_r2l_orientation";
184 
185   /** Document property to set throw of exception on parsing format error */
186   public static final String THROWEX_FORMAT_PROPERTY_NAME =
187       "throwExceptionOnFormatError";
188 
189   /** The key for the WordNet config file */
190   public static final String WORDNET_CONFIG_FILE = "Wordnet_config_file";
191 
192   // /** The index type of corpus*/
193   // public static final int IR_LUCENE_INVFILE = 1001;
194   /** Property for document new line type. Values {"CR", "LF", "CRLF", "LFCR"} */
195   public static final String DOCUMENT_NEW_LINE_TYPE = "docNewLineType";
196 
197   /**
198    * The key for the gate.xml option to specify a compiler type to use to build
199    * the Java files compiled from JAPE grammars.
200    */
201   public static final String COMPILER_TYPE_KEY = "Compiler_type";
202 
203   /**
204    * Key used in resource features for hiding the resource fromthe GUI.
205    */
206   public static final String HIDDEN_FEATURE_KEY = "gate.HIDDEN";
207 
208   /**
209    * Key used in TOOL actions to store the 'menu path' under which the action
210    * should be placed in the Tools menu.
211    */
212   public static final String MENU_PATH_KEY = "gate.MenuPath";
213 
214   /**
215    * Keys used in gate.xml or user config to specify the feature name to use to
216    * add to annotations in Original markups AS that contain namespace URI and
217    * prefix information. E.g. title
218    * namespaceURI="http://purl.org/dc/elements/1.1/" namespacePrefix="dc"
219    */
220   public static final String ADD_NAMESPACE_FEATURES = "addNamespaceFeatures";
221 
222   public static final String ELEMENT_NAMESPACE_URI = "namespaceURI";
223 
224   public static final String ELEMENT_NAMESPACE_PREFIX = "namespacePrefix";
225 // GateConstants