| GateConstants.java |
1 /*
2 * GateConstants.java
3 *
4 * Copyright (c) 1998-2005, 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.29 2005/09/22 13:07:04 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 the installed plug-ins directory */
25 public static final String PLUGINS = "plugins";
26
27 /** The name of session state data files (<TT>gate.session</TT>). */
28 public static final String GATE_DOT_SER = "gate.session";
29
30 /** The name of the site config property (<TT>gate.config</TT>). */
31 public static final String GATE_CONFIG_PROPERTY = "gate.config";
32
33 /** The name of the annotation set storing original markups in a document */
34 public static final String
35 ORIGINAL_MARKUPS_ANNOT_SET_NAME = "Original markups";
36
37 /** The option name for the last filechooser location. */
38 public static final String
39 LAST_FILECHOOSER_LOCATION = "Last_filechooser_location";
40
41 /** The look and feel option name*/
42 public static final String LOOK_AND_FEEL = "Look_and_Feel";
43
44 /** The key for the font used for text components*/
45 public static final String TEXT_COMPONENTS_FONT = "Text_components_font";
46
47 /** The key for the font used for menus*/
48 public static final String MENUS_FONT = "Menus_font";
49
50 /** The key for the font used for other GUI components*/
51 public static final String OTHER_COMPONENTS_FONT = "Other_components_font";
52
53 /** The key for the main window width*/
54 public static final String MAIN_FRAME_WIDTH = "Main_frame_width";
55
56 /** The key for the main window height*/
57 public static final String MAIN_FRAME_HEIGHT = "Main_frame_height";
58
59 /** The key for the save options on exit value*/
60 public static final String SAVE_OPTIONS_ON_EXIT = "Save_options_on_exit";
61
62 /** The key for the save session on exit value*/
63 public static final String SAVE_SESSION_ON_EXIT = "Save_session_on_exit";
64
65 /** The key for saving the features when preserving format*/
66 public static final String SAVE_FEATURES_WHEN_PRESERVING_FORMAT =
67 "Save_features_when_preserving_format";
68
69 /**
70 * The key for the known plugins path option in the GATE config map
71 */
72 public static final String KNOWN_PLUGIN_PATH_KEY = "Known_plugin_path";
73
74 /**
75 * The key for the autoload plugins path option in the GATE config map
76 */
77 public static final String AUTOLOAD_PLUGIN_PATH_KEY = "Load_plugin_path";
78
79 /**
80 * The name for the autoload plugins path system property
81 */
82 public static final String AUTOLOAD_PLUGIN_PATH_PROPERTY_NAME = "load.plugin.path";
83
84 /**
85 * The name of the GATE home system property
86 */
87 public static final String GATE_HOME_PROPERTY_NAME = "gate.home";
88
89 /**
90 * The name of the GATE plugins home system property
91 */
92 public static final String PLUGINS_HOME_PROPERTY_NAME = "gate.plugins.home";
93
94 /**
95 * The name of the GATE site config system property
96 */
97 public static final String SITE_CONFIG_PROPERTY_NAME = "gate.site.config";
98 /**
99 * The name of the GATE user config system property
100 */
101 public static final String USER_CONFIG_PROPERTY_NAME = "gate.user.config";
102
103 /**
104 * The name of the GATE site config system property
105 */
106 public static final String GATE_SITE_CONFIG_PROPERTY_NAME = "gate.site.config";
107
108 /**
109 * The name of the GATE user config system property
110 */
111 public static final String GATE_USER_CONFIG_PROPERTY_NAME = "gate.user.config";
112
113
114 /** The key for the feature keeping the original content of the document */
115 public static final String
116 ORIGINAL_DOCUMENT_CONTENT_FEATURE_NAME = "Original_document_content_on_load";
117
118 /** The key for the feature keeping the repositioning information
119 * between original and displayed content of the document*/
120 public static final String
121 DOCUMENT_REPOSITIONING_INFO_FEATURE_NAME = "Document_repositioning_info";
122
123 /** */
124 public static final String
125 DOCUMENT_ADD_SPACE_ON_UNPACK_FEATURE_NAME = "Document_add_space_on_unpack";
126
127 /** Property to set title of application from command line */
128 public static final String TITLE_JAVA_PROPERTY_NAME = "gate.slug.title";
129
130 /** Property to set icon of application from command line */
131 public static final String APP_ICON_JAVA_PROPERTY_NAME = "gate.slug.icon";
132
133 /** Property to set splash of application from command line */
134 public static final String APP_SPLASH_JAVA_PROPERTY_NAME = "gate.slug.splash";
135
136 /** Property to set help about box from command line */
137 public static final String ABOUT_URL_JAVA_PROPERTY_NAME = "gate.slug.abouturl";
138
139 /** Property to set slug application from command line */
140 public static final String APPLICATION_JAVA_PROPERTY_NAME = "gate.slug.app";
141
142 /** Property to set slug annotation types for export Inline */
143 public static final String ANNOT_TYPE_TO_EXPORT = "annotTypesToExport";
144
145 /** The key for the feature keeping the IndexDefinition*/
146 public static final String
147 CORPUS_INDEX_DEFINITION_FEATURE_KEY = "Index_definition_feature_key";
148
149 /** The key for the feature keeping the IndexStatistics*/
150 public static final String
151 CORPUS_INDEX_STATISTICS_FEATURE_KEY = "Index_statistics_feature_key";
152
153 /** The key used for document editor inser behaviour */
154 public static final String DOCEDIT_INSERT_APPEND = "docedit_insert_append";
155
156 /** The key used for document editor inser behaviour */
157 public static final String DOCEDIT_INSERT_PREPEND = "docedit_insert_prepend";
158
159 /** Document property to set throw of exception on parsing format error */
160 public static final String THROWEX_FORMAT_PROPERTY_NAME =
161 "throwExceptionOnFormatError";
162
163 /** The key for the WordNet config file*/
164 public static final String WORDNET_CONFIG_FILE = "Wordnet_config_file";
165
166 // /** The index type of corpus*/
167 // public static final int IR_LUCENE_INVFILE = 1001;
168
169 /** Property for document new line type. Values {"CR", "LF", "CRLF", "LFCR"}*/
170 public static final String DOCUMENT_NEW_LINE_TYPE = "docNewLineType";
171
172 /**
173 * The key for the gate.xml option to specify a compiler type to use to build
174 * the Java files compiled from JAPE grammars.
175 */
176 public static final String COMPILER_TYPE_KEY = "Compiler_type";
177
178 } // GateConstants
179