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