001 /*
002 * Constants.java
003 *
004 * Niraj Aswani, 19/March/07
005 *
006 * $Id: Constants.html,v 1.0 2007/03/19 16:22:01 niraj Exp $
007 */
008 package gate.creole.annic;
009
010 /**
011 * Constants used by annic classes.
012 * @author niraj
013 *
014 */
015 public class Constants {
016
017 /**
018 * Name of the document_id_field that is stored in index.
019 */
020 public final static String DOCUMENT_ID = "DOCUMENT_ID";
021
022 /**
023 * Name of the document_id_field that is stored in index.
024 */
025 public final static String DOCUMENT_ID_FOR_SERIALIZED_FILE = "DOCUMENT_ID_FOR_SERIALIZED_FILE";
026
027 /**
028 * Indexed features
029 */
030 public final static String INDEXED_FEATURES = "INDEXED_FEATURES";
031
032 /**
033 * Default annotation set name
034 */
035 public final static String DEFAULT_ANNOTATION_SET_NAME = "<null>";
036
037 /**
038 * create tokens automatically parameter name
039 */
040 public final static String CREATE_TOKENS_AUTOMATICALLY = "CREATE_TOKENS_AUTOMATICALLY";
041
042 /**
043 *
044 * Annic token which is created when no tokens are provided
045 */
046 public final static String ANNIC_TOKEN = "Token";
047
048 /**
049 * name of the index_location_url parameter.
050 */
051 public final static String INDEX_LOCATION_URL = "INDEX_LOCATION_URL";
052
053 /**
054 * Name of the annotation_sets_names_to_include parameter.
055 */
056 public final static String ANNOTATION_SETS_NAMES_TO_INCLUDE = "ANNOTATION_SETS_NAMES_TO_INCLUDE";
057
058 /**
059 * Name of the annotation_sets_names_to_exclude parameter.
060 */
061 public final static String ANNOTATION_SETS_NAMES_TO_EXCLUDE = "ANNOTATION_SETS_NAMES_TO_EXCLUDE";
062
063 /**
064 * Name of the features_to_exclude parameter.
065 */
066 public final static String FEATURES_TO_EXCLUDE = "FEATURES_TO_EXCLUDE";
067
068 /**
069 * Name of the features_to_include parameter.
070 */
071 public final static String FEATURES_TO_INCLUDE = "FEATURES_TO_INCLUDE";
072
073
074 /**
075 * Name of the base_token_annotation_type parameter.
076 */
077 public final static String BASE_TOKEN_ANNOTATION_TYPE = "BASE_TOKEN_ANNOTATION_TYPE";
078
079 /**
080 * Name of the index_unit_annotation_type parameter.
081 */
082 public final static String INDEX_UNIT_ANNOTATION_TYPE = "INDEX_UNIT_ANNOTATION_TYPE";
083
084 /**
085 * Name of the corpus_index_feature parameter.
086 */
087 public final static String CORPUS_INDEX_FEATURE = "CorpusIndexFeature";
088
089 /**
090 * default value for the corpus_index_feature
091 */
092 public final static String CORPUS_INDEX_FEATURE_VALUE = "AnnicIR";
093
094 /**
095 * Name of the corpus_size parameter.
096 */
097 public final static String CORPUS_SIZE = "CORPUS_SIZE";
098
099 /**
100 * Name of the context_window parameter.
101 */
102 public final static String CONTEXT_WINDOW = "CONTEXT_WINDOW";
103
104 /**
105 * Name of the index_locations parameter.
106 */
107 public final static String INDEX_LOCATIONS = "INDEX_LOCATIONS";
108
109 /**
110 * folder name used for creating a folder which is then used for serializing the files
111 */
112 public final static String SERIALIZED_FOLDER_NAME = "serialized-files";
113
114 /**
115 * Name of the corpus_id parameter.
116 */
117 public final static String CORPUS_ID = "CORPUS_ID";
118
119 /**
120 * Name of the annotation set id parameter
121 */
122 public final static String ANNOTATION_SET_ID = "ANNOTATION_SET_ID";
123
124 /**
125 * Contains the merged annotation set in combined sets.
126 */
127 public final static String COMBINED_SET = "Combined sets";
128
129 /**
130 * Contains the merged annotation set.
131 */
132 public final static String ALL_SETS = "All sets";
133
134 /**
135 * Contains the entire datastore.
136 */
137 public final static String ENTIRE_DATASTORE = "Entire datastore";
138 }
|