Constants.java

Go to the documentation of this file.

/*
 * Project: Server for annotations sharing
 * Author: Ing. Jaroslav Dytrych idytrych@fit.vutbr.cz
 * File: Constants.java
 * Description: Class with global constants
 */

/**
 * @file Constants.java
 *
 * @brief Global constants
 */

package cz.vutbr.fit.knot.annotations.app;

import java.util.ArrayList;
import java.util.Arrays;

/**
 * Class with global constants
 *
 * @brief Global constants
 * @author idytrych
 */
public class Constants {
  /** Default server URI */
  public static final String SERVER_URI = "http://localhost:8080";
  //public static final String SERVER_URI = "http://knot09.fit.vutbr.cz:8080";
  /** Context (defined in context.xml) */
  public static final String URI_C = "Annotations";
  /** End of beginning of URI of annotation */
  public static final String ANNOT_URI_SUFFIX = "/annotations/";
  /** End of beginning of URI of suggestion */
  public static final String SUG_URI_SUFFIX = "/suggestions/";
  /** End of beginning of URI of annotation type */
  public static final String TYPE_URI_SUFFIX = "/types/";
  /** End of beginning of URI of annotated copy of document */
  public static final String DOC_URI_SUFFIX = "/documents/getDoc?id=";
  /** End of beginning of URI of annotation author (person) */
  public static final String AUTHOR_URI_SUFFIX = "/authors/";
  /** End of beginning of URI of annotation author (person) */
  public static final String USER_URI_SUFFIX = "/user/";
  /** End of beginning of URI of annotation author (person) for protocol V2 */
  public static final String USER_URI_SUFFIX_V2 = "/users/";
  /** End of beginning of URI of user group */
  public static final String GROUP_URI_SUFFIX = "/groups/";
  /** End of base URI for ontology upload */
  public static final String ONTO_UPLOAD_URI_SUFFIX = "/";
  /** End of beginning of URI of stored document */
  public static final String S_DOC_URI_SUFFIX = "/getDocument?id=";
  /** End of beginning of URI of subscription */
  public static final String SUBSCR_URI_SUFFIX = "/subscriptions/";

  /** IP addresses of Drupals, which can add and authenticate users */
  public static final ArrayList<String> DRUPAL_IPS_ALLOWED = new ArrayList<String>(Arrays.asList(
  ""
  ));
  /** Host names of Drupals, which can add and authenticate users */
  public static final ArrayList<String> DRUPAL_HOSTS_ALLOWED = new ArrayList<String>(Arrays.asList(
  ""
  ));
  /** Authentication types for Drupals - no authentication */
  public static final int AUTH_DRUPAL_BY_NOTHING = 0;
  /** Authentication types for Drupals - authentication by IP */
  public static final int AUTH_DRUPAL_BY_IP = 1;
  /** Authentication types for Drupals - authentication by host name */
  public static final int AUTH_DRUPAL_BY_HOST = 2;
  /** Authentication type which will be used for Drupal */
  public static final int AUTH_DRUPAL = AUTH_DRUPAL_BY_NOTHING;
  // Note: this is not secure authentication mechanism, but for trials it can be useful.

  /** Logging level - no logging */
  public static final int LOG_LEVEL_NONE = 0;
  /** Logging level - server internal errors (very bad) */
  public static final int LOG_LEVEL_SERVER_INTERNAL_ERRORS = 1;
  /** Logging level - all server errors */
  public static final int LOG_LEVEL_SERVER_ERRORS = 2;
  /** Logging level - all serious errors (user should not achieve, but can be on client side) */
  public static final int LOG_LEVEL_ALL_ERRORS = 3;
  /** Logging level - all informations (error can be achieved by bad user action) */
  public static final int LOG_LEVEL_ALL = 4;
  /** Logging level used */
  public static final int LOG_LEVEL = LOG_LEVEL_ALL;

  /** If true, annotation types imported from ontology will have restricted attributes */
  public static final boolean RESTRICT_TYPES_IMPORTED_FROM_ONTO = false;

  /** If user's groups shall be automatically subscribed, set to true, false otherwise */
  public static final boolean AUTO_SUBSCRIBE_OWN_GROUPS = true;

  /**
   * Comet handler timeout in seconds
   * After timeout expires, following message is sent:
   * @verbatim
   * <ok/>
   * @endverbatim
   */
  public static final int COMET_TIMEOUT_SEC = 60;  // 1 min.
  /** Comet context path*/
  public static final String COMET_CONTEXT_PATH = "/AnnotEditorsComet";

  /** Level of definition of protocol v 1.0 - 2.0 */
  public static final int PROTOCOL_LOD_V1   = 1;
  /** Level of definition of protocol v 1.1 - 2.0 */
  public static final int PROTOCOL_LOD_V1_1 = 2;
  /** Level of definition of protocol v 2.0+ */
  public static final int PROTOCOL_LOD_V2   = 3;

  /** URI parameters to be removed from each URI of annotated document */
  public static final ArrayList<String> REM_URI_PARAMS = new ArrayList<String>(Arrays.asList(
    "PHPSESSID",
    "SID",
    "sid",
    "session"
  ));

  /** Number of suggestion refuse method - refused manually */
  public static final int REFUSED_MANUALLY = 0;
  /** Number of suggestion refuse method - refused automatically */
  public static final int REFUSED_AUTOMATICALLY = 1;

  /** Names of suggestion refuse methods */
  public static final ArrayList<String> REFUSE_METHODS = new ArrayList<String>(Arrays.asList(
    "manually",
    "automatically"
  ));

  /** Number of suggestion confirmation method - confirmed manually */
  public static final int CONFIRMED_MANUALLY = 0;
  /** Number of suggestion confirmation method - confirmed manually with editation */
  public static final int CONFIRMED_MANUALLY_EDITED = 1;
  /** Number of suggestion confirmation method - confirmed automatically */
  public static final int CONFIRMED_AUTOMATICALLY = 2;
  /** Number of suggestion confirmation method - confirmed automatically with editation */
  public static final int CONFIRMED_AUTOMATICALLY_EDITED = 3;

  /** Names of suggestion confirmation methods */
  public static final ArrayList<String> CONFIRM_METHODS = new ArrayList<String>(Arrays.asList(
    "manually",
    "manuallyEdited",
    "automatically",
    "AutomaticallyEdited"
  ));

  /** Modes of text modifications - insert before */
  public static final int TEXT_MOD_INS_BEFORE = 1;
  /** Modes of text modifications - replace */
  public static final int TEXT_MOD_REPLACE = 2;
  /** Modes of text modifications - insert after */
  public static final int TEXT_MOD_INS_AFTER = 3;

  /** Names of supported simple data types of attributes */
  public static final ArrayList<String> SIMPLE_TYPES = new ArrayList<String>(Arrays.asList(
    "String",
    "URI",
    "Image",
    "DateTime",
    "Integer",
    "Decimal",
    "Date",
    "Time",
    "Boolean",
    "person", /* fix low first letter case */
    "Person",
    "geoPoint", /* fix low first letter case */
    "GeoPoint",
    "AnyAnnotation", /* supported since protocol version 1.1 */
    "Duration",
    "Binary",
    "Text",
    "Entity"
  ));
  
  /** URIs of simple types in protocol v 2.0 */
  public static final ArrayList<String> SIMPLE_TYPES_URI_V2 = new ArrayList<String>(Arrays.asList(
    "http://www.w3.org/2001/XMLSchema#string",
    "http://knot.fit.vutbr.cz/annotations/knotOAExtension#entity",
    "http://knot.fit.vutbr.cz/annotations/knotOAExtension#text",
    "http://www.w3.org/2001/XMLSchema#base64binary",
    "http://www.w3.org/2001/XMLSchema#duration",
    "http://www.w3.org/2001/XMLSchema#time",
    "http://www.w3.org/2001/XMLSchema#anyUri",
    "http://www.w3.org/2003/01/geo/wgs84_pos#Point",
    "http://knot.fit.vutbr.cz/annotations/knotOAExtension#imageUri",
    "http://www.w3.org/2001/XMLSchema#integer",
    "http://knot.fit.vutbr.cz/annotations/knotOAExtension#anyAnnotation",   
    "http://www.w3.org/2001/XMLSchema#boolean",
    "http://www.w3.org/2001/XMLSchema#date",
    "http://www.w3.org/2001/XMLSchema#dateTime",
    "http://www.w3.org/2001/XMLSchema#decimal"
  ));
  
  /** Names of simple types in protocol v 2.0 */
  public static final ArrayList<String> SIMPLE_TYPES_NAMES_V2 = new ArrayList<String>(Arrays.asList(
    "String",
    "Entity",
    "Text",
    "Binary",
    "Duration",
    "Time",
    "URI",
    "GeoPoint",
    "Image",
    "Integer",
    "AnyAnnotation",   
    "Boolean",
    "Date",
    "DateTime",
    "Decimal"
  ));
  
  /** Names of supported simple data types of entity additional attributes */
  public static final ArrayList<String> SIMPLE_TYPES_FOR_ENT_AD_AT = new ArrayList<String>(Arrays.asList(
    "String",
    "URI"
  ));
  
  /** URIs of supported simple data types of entity additional attributes */
  public static final ArrayList<String> SIMPLE_TYPES_URIS_FOR_ENT_AD_AT = new ArrayList<String>(Arrays.asList(
    "http://www.w3.org/2001/XMLSchema#string",
    "http://www.w3.org/2001/XMLSchema#anyUri"
  ));
  
  /** Name of default simple data type of entity additional attribute */
  public static final String DEFAULT_SIMPLE_TYPE_FOR_ENT_AD_AT = "String";
  
  /** Primitive datatypes URIs*/
  public static final String STRING_URI = "http://www.w3.org/2001/XMLSchema#string";
  public static final String BINARY_URI = "http://www.w3.org/2001/XMLSchema#base64Binary";
  public static final String BOOLEAN_URI = "http://www.w3.org/2001/XMLSchema#boolean";
  public static final String DATE_URI = "http://www.w3.org/2001/XMLSchema#date";
  public static final String DATE_TIME_URI = "http://www.w3.org/2001/XMLSchema#dateTime";
  public static final String DECIMAL_URI = "http://www.w3.org/2001/XMLSchema#decimal";
  public static final String DURATION_URI = "http://www.w3.org/2001/XMLSchema#duration";
  public static final String GEO_POINT_URI = "http://www.w3.org/2003/01/geo/wgs84_pos#Point";
  public static final String IMAGE_URI = "http://knot.fit.vutbr.cz/annotations/AnnotXMLSchema#image";
  public static final String INTEGER_URI = "http://www.w3.org/2001/XMLSchema#integer";
  public static final String LINKED_ANNOT_URI = "http://www.w3.org/2001/XMLSchema#";
  public static final String NESTED_ANNOT_URI = "http://www.w3.org/2001/XMLSchema#";
  public static final String PERSON_URI = "http://knot.fit.vutbr.cz/annotations/AnnotXMLSchema#person";
  public static final String TEXT_URI = "http://www.w3.org/2001/XMLSchema#string";
  public static final String TIME_URI = "http://www.w3.org/2001/XMLSchema#time";
  public static final String ANOTHER_URI_URI = "http://www.w3.org/2001/XMLSchema#anyURI";
  public static final String ENTITY_URI = "http://knot.fit.vutbr.cz/annotations/AnnotXMLSchema#entity";

  /** Namespaces used for protocol version 1.x */
  public static final int NAMESPACES_LOD_V1 = 1;
  /** Namespaces used for protocol version 2.x */
  public static final int NAMESPACES_LOD_V2 = 2;

  /** Namespaces to be defined in message for client */
  public static final String [][] nameSpaces = {{},{
    // Protocol version 1.x
    " xmlns:rdf=\"http://www.w3.org/2003/01/geo/wgs84_pos#\"",
    " xmlns:geo=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"",
    " xmlns:a=\"http://knot.fit.vutbr.cz/annotations/AnnotXMLSchema\""},
  { 
    // Protocol version 2.x
    " xmlns:oa=\"http://www.w3.org/ns/oa#\"",
    " xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"",
    " xmlns:dcterms=\"http://purl.org/dc/terms/\"",
    " xmlns:dc=\"http://purl.org/dc/elements/1.1/\"",
    " xmlns:dctypes=\"http://purl.org/dc/dcmitype/\"",
    " xmlns:cnt=\"http://www.w3.org/2011/content#\"",
    " xmlns:xsd=\"http://www.w3.org/2001/XMLSchema/\"",
    " xmlns:trix=\"http://www.w3.org/2004/03/trix/trix-1/\"",
    " xmlns:foaf=\"http://xmlns.com/foaf/0.1/\"",
    " xmlns:geo=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"" ,
    " xmlns:koae=\"http://knot.fit.vutbr.cz/annotations/knotOAExtension\""}
  };

  /** Simple type for empty Entity */
  public static final String EMPTY_ENTITY = "http://knot.fit.vutbr.cz/annotations/knotOAExtension#anyEntity";
  
  /** Name of user settings parameter with server language settings */
  public static final String SETTINGS_PARAM_SERVER_LANGUAGE = "ServerLanguage";
  /** Name of user settings parameter with default user group */
  public static final String SETTINGS_PARAM_DEFAULT_GROUP = "DefaultUserGroup";
  /** Name of user settings parameter with attribute filter */
  public static final String SETTINGS_PARAM_ATT_FILTER = "FilterAttributes";
  /** Name of user settings parameter with setting for update of negative feedback */
  public static final String SETTINGS_PARAM_UPDATE_NEG_FEEDBACK_FOR_REFUSED_BY_SAME = "refuseOthersFromAllFragments";
  /** Name of user settings parameter with enabling of update of positive feedback */
  public static final String SETTINGS_PARAM_ENABLE_UPDATE_POSITIVE_FEEDBACK = "autoconfirmOthers";
  /** Name of user settings parameter with enabling of automatic activation of alternative suggestions */
  public static final String SETTINGS_PARAM_AUTO_ALTERNATIVES = "autoAlternatives";
  /** Name of user settings parameter denoting whether confidence should be displayed for suggestions */
  public static final String SETTINGS_PARAM_DISPLAY_SUG_CONFIDENCE = "displaySugConfidence";
  /** Name of user settings parameter denoting whether KB_Ref mode is on */
  public static final String SETTINGS_PARAM_KB_REF_MODE = "KBRefMode";
  /** Name of KB_Ref attribute */
  public static final String KB_REF_ATT_NAME = "KB_Ref";
  /** Name of user group in which is only administrators (ignore case) */
  public static final String ADMIN_GROUP = "Administrators";
  /** Name of special attribute for updatable annotation */
  public static final String UPDATABLE_AN_AT_NAME = "updatable_annotation";

  /** Minimum number of characters in XPath to can ignore change */
  public static final int MIN_XPATH_L_TO_AUTO_MODIFY_FR = 10;
  /** Minimum number of characters in annotated text to can ignore change */
  public static final int MIN_TEXT_L_TO_AUTO_MODIFY_FR = 10;
  /** Maximum Levenshtein distance of ignored change */
  public static final double MAX_XPATH_LD_TO_AUTO_MODIFY_FR = 0.04;  // 4%
  /**
   * Minimum difference of minimal and second minimal Levenshtein distance to
   * can ignore change.
   */
  public static final double MIN_XPATH_LD_DIFF_TO_AUTO_MODIFY_FR = 0.03; // 3%
  /** Maximum offset diference */
  public static final int MAX_OFFSET_DIFF_TO_AUTO_MODIFY_FR = 178;
  /** Maximum annotated text Levenshtein distance */
  public static final double MAX_TEXT_LD_TO_AUTO_MODIFY_FR = 0.67; // 67%
  /** Maximum annotation difference to synchronize document */
  public static final int MAX_ANNOTATION_DIFFERENCE = 34; // 34%
  /** Reserve for getting maximum numbers of entities */
  public static final double SEC_API_AUTOCOMPLETE_RESULTS_RESERVE = 30.0; // 30%
  
  /** Mime types of supported documents to upload */
  public static final ArrayList<String> DOC_UPLOAD_TYPES = new ArrayList<String>(Arrays.asList(
    "text/html",
    "text/xml",
    "application/xml"
  ));

  /** Default address of the SEC server for annotation suggestions. */
  public static final String SEC_SERVER_URI = "http://knot09.fit.vutbr.cz:8081";
  /** Default address of the SEC API server for annotation suggestions. */
  public static final String SEC_API_SERVER_URI = "http://sec.fit.vutbr.cz:8082";
  //public static final String SEC_API_SERVER_URI = "http://knot09.fit.vutbr.cz:8082";
  /** Maximum time that the session is idle */
  public static final int SESSION_CLEAN_INTERVAL = 10;
  /** Indicator of subscribed type */
  public static final int SUBSCRIBED = 0;
  /** Indicator of unsubscribed type */
  public static final int UNSUBSCRIBED = 1;
  /** Indicate that annotation type isn't supscribe and unsubscribe list*/
  public static final int NOTHING = 2;
  
  public static final boolean TEST_ANNOT_LINK_URI = true;
  
  /** Should be SEC API used for suggestions? */
  public static final boolean SEC_API_SUGGESTIONS = true;
  
  /** Should be visual representation changed from file name to URI? */
  public static final boolean VISUAL_REPRESENTATION_URI_CHANGE = true;
  
  /** Default URI prefix for images from controlled vocabulary */
  public static final String KB_IMAGE_PREFIX = "http://athena3.fit.vutbr.cz/kb/images/freebase/";
  
  /** Each suggestion can have some alternatives. This number specifies its maximum count.*/
  public static final int MAX_COUNT_OF_ALTERNATIVES_TO_ONE_SUGGESTION = 10;
  
  /** Alternatives are displayed in batches. This number specifies the amount of alternatives in one batch. */
  public static final int MAX_COUNT_OF_ALTERNATIVES_IN_BATCH = 5;
  
  /** Name of entry in server settings for server URI */
  public static final String SERVER_URI_SETTING_NAME = "serverURI";
  
  /** Name of entry in server settings for SEC API server URI */
  public static final String SEC_API_SERVER_URI_SETTING_NAME = "SECAPIserverURI";
  
  /** Name of entry in server settings for default URI prefix for images from controlled vocabulary */
  public static final String KB_IMG_PREFIX_SETTING_NAME = "KBimagePrefix";
  
  /** Name of entry in server settings for desired types and attributes */
  public static final String SEC_DESIRED_TYPES_SETTINGS_NAME = "SECDesiredTypes";
  
  /** Name of entry in server settings for unnecessary types */
  public static final String SEC_UNNECESSARY_TYPES_SETTINGS_NAME = "SECUnnecessaryTypes";
  
  /** Name of entry in server settings for unnecessary attributes */
  public static final String SEC_UNNECESSARY_AT_SETTINGS_NAME = "SECUnnecessaryAttributes";
  
  /** Name of entry in server settings for desired types and attributes for entity autocomplete */
  public static final String SEC_DESIRED_TYPES_SETTINGS_NAME_EA = "SECDesiredTypesEA";
  
  /** Name of entry in server settings for unnecessary types for entity autocomplete */
  public static final String SEC_UNNECESSARY_TYPES_SETTINGS_NAME_EA = "SECUnnecessaryTypesEA";
  
  /** Name of entry in server settings for unnecessary attributes for entity autocomplete */
  public static final String SEC_UNNECESSARY_AT_SETTINGS_NAME_EA = "SECUnnecessaryAttributeseEA";
  
  /** Name of entry in server settings for maximum results for getting entities (autocomplete) */
  public static final String MAX_ENTITIES_SETTINGS_NAME = "MaxEntities";
  
  /** Should be identifier attribute added to SEC attributes? */
  public static final Boolean ADD_IDENTIFIER = true;
  
  /** Should be identifier transformed to entity uri in suggestion? */
  public static final Boolean IDENTIFIER_TO_ENTITY_URI = true;
  
  /** Should be disambiguation attribute added to SEC attributes? */
  public static final Boolean ADD_DISAMBIGUATION = true;
  
  /** Should be confidence attribute added to SEC attributes? */
  public static final Boolean ADD_CONFIDENCE = true;
  
  /** 
   * Should be display_term transformed to (person) name in suggestion? 
   * This is just for output improvement with actual knowledge base.
   */
  public static final Boolean DISPLAY_TERM_TO_NAME = true;
  
  /** Should be partial URI of image completed */
  public static final Boolean COMPLETE_IMAGE_URI = true;
  
  /** 
   * Should be remote SEC API server used? 
   * If SEC API command is set in DB, but it is empty, it will be used automatically.
   */
  public static final Boolean USE_REMOTE_SEC_API = true;
  
  /** 
   * Server setting name for setting whether Should be usage of getAlternativesFor 
   * logged (for measurement purposes).
   */
  public static final String LOG_GET_ALTERNATIVES_SETTINGS = "logGetAlternativesFor";
  
  /** List of special server settings (can not be set directly) */
  public static final ArrayList<String> SPECIAL_SETTINGS = new ArrayList<String>(Arrays.asList(
    "serverURI"
  ));
  
  /** List of server settings which needs AppBean URIs reset */
  public static final ArrayList<String> SETTINGS_RESET = new ArrayList<String>(Arrays.asList(
    "KBimagePrefix",
    "SECAPIserverURI",
    "logGetAlternativesFor"
  ));
  
  /** List of types of entities which can not be used in get_entities request */
  public static final ArrayList<String> FORBIDDEN_ENTITY_TYPES = new ArrayList<String>(Arrays.asList(
    "date",
    "interval",
    "activity"
  ));
  
  /** List of refuse border separators */
  public static final ArrayList<String> REFUSE_BORDER_SEPARATOR = new ArrayList<String>(Arrays.asList(
    "- - -"
  ));
  
}  // class Constants