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.26 2004/11/23 18:14:24 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  
38    /** The look and feel option name*/
39    public static final String LOOK_AND_FEEL = "Look_and_Feel";
40  
41    /** The key for the font used for text components*/
42    public static final String TEXT_COMPONENTS_FONT = "Text_components_font";
43  
44    /** The key for the font used for menus*/
45    public static final String MENUS_FONT = "Menus_font";
46  
47    /** The key for the font used for other GUI components*/
48    public static final String OTHER_COMPONENTS_FONT = "Other_components_font";
49  
50    /** The key for the main window width*/
51    public static final String MAIN_FRAME_WIDTH = "Main_frame_width";
52  
53    /** The key for the main window height*/
54    public static final String MAIN_FRAME_HEIGHT = "Main_frame_height";
55  
56    /** The key for the save options on exit value*/
57    public static final String SAVE_OPTIONS_ON_EXIT = "Save_options_on_exit";
58  
59    /** The key for the save session on exit value*/
60    public static final String SAVE_SESSION_ON_EXIT = "Save_session_on_exit";
61  
62    /** The key for saving the features when preserving format*/
63    public static final String SAVE_FEATURES_WHEN_PRESERVING_FORMAT =
64      "Save_features_when_preserving_format";
65  
66    /**
67     * The key for the known plugins path option in the GATE config map
68     */
69    public static final String KNOWN_PLUGIN_PATH_KEY = "Known_plugin_path";
70    
71    /**
72     * The key for the autoload plugins path option in the GATE config map
73     */
74    public static final String AUTOLOAD_PLUGIN_PATH_KEY = "Load_plugin_path";
75    
76    /**
77     * The name for the autoload plugins path system property
78     */
79    public static final String AUTOLOAD_PLUGIN_PATH_PROPERTY_NAME = "load.plugin.path";
80  
81    /**
82     * The name of the GATE home system property
83     */
84    public static final String GATE_HOME_PROPERTY_NAME = "gate.home";
85  
86    /**
87     * The name of the GATE plugins home system property
88     */
89    public static final String PLUGINS_HOME_PROPERTY_NAME = "gate.plugins.home";
90  
91    /**
92     * The name of the GATE site config system property
93     */
94    public static final String SITE_CONFIG_PROPERTY_NAME = "gate.site.config";
95   /** 
96    * The name of the GATE user config system property
97    */
98   public static final String USER_CONFIG_PROPERTY_NAME = "gate.user.config";
99    
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 key for the feature keeping the original content of the document */
112   public static final String
113    ORIGINAL_DOCUMENT_CONTENT_FEATURE_NAME = "Original_document_content_on_load";
114 
115   /** The key for the feature keeping the repositioning information
116    *  between original and displayed content of the document*/
117   public static final String
118     DOCUMENT_REPOSITIONING_INFO_FEATURE_NAME = "Document_repositioning_info";
119 
120   /** */
121   public static final String
122     DOCUMENT_ADD_SPACE_ON_UNPACK_FEATURE_NAME = "Document_add_space_on_unpack";
123 
124   /** Property to set title of application from command line */
125   public static final String TITLE_JAVA_PROPERTY_NAME = "gate.slug.title";
126 
127   /** Property to set icon of application from command line */
128   public static final String APP_ICON_JAVA_PROPERTY_NAME = "gate.slug.icon";
129 
130   /** Property to set splash of application from command line */
131   public static final String APP_SPLASH_JAVA_PROPERTY_NAME = "gate.slug.splash";
132 
133   /** Property to set help about box from command line */
134   public static final String ABOUT_URL_JAVA_PROPERTY_NAME = "gate.slug.abouturl";
135 
136   /** Property to set slug application from command line */
137   public static final String APPLICATION_JAVA_PROPERTY_NAME = "gate.slug.app";
138 
139   /** Property to set slug annotation types for export Inline */
140   public static final String ANNOT_TYPE_TO_EXPORT = "annotTypesToExport";
141 
142   /** The key for the feature keeping the IndexDefinition*/
143   public static final String
144     CORPUS_INDEX_DEFINITION_FEATURE_KEY = "Index_definition_feature_key";
145 
146   /** The key for the feature keeping the IndexStatistics*/
147   public static final String
148     CORPUS_INDEX_STATISTICS_FEATURE_KEY = "Index_statistics_feature_key";
149 
150   /** The key used for document editor inser behaviour */
151   public static final String DOCEDIT_INSERT_APPEND = "docedit_insert_append";
152 
153   /** The key used for document editor inser behaviour */
154   public static final String DOCEDIT_INSERT_PREPEND = "docedit_insert_prepend";
155 
156   /** Document property to set throw of exception on parsing format error */
157   public static final String THROWEX_FORMAT_PROPERTY_NAME =
158     "throwExceptionOnFormatError";
159 
160   /** The key for the WordNet config file*/
161   public static final String WORDNET_CONFIG_FILE = "Wordnet_config_file";
162 
163 //  /** The index type of corpus*/
164 //  public static final int IR_LUCENE_INVFILE = 1001;
165 
166   /** Property for document new line type. Values {"CR", "LF", "CRLF", "LFCR"}*/
167   public static final String DOCUMENT_NEW_LINE_TYPE = "docNewLineType";
168 
169 } // GateConstants