001/*
002 *  Copyright 2016 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.plugins.extraction;
017
018import java.io.File;
019
020/**
021 * Constants related to extraction.
022 */
023public interface ExtractionConstants
024{
025    /** Right id to execute extractions */
026    public static final String EXECUTE_EXTRACTION_RIGHT_ID = "Extraction_Rights_ExecuteExtraction";
027    
028    /** Right id to modify extractions */
029    public static final String MODIFY_EXTRACTION_RIGHT_ID = "Extraction_Rights_EditExtraction";
030    
031    /** Path of the base directory for extraction files */
032    public static final String BASE_DIR = "context://WEB-INF/param/extraction/";
033    
034    /** Plugin name to use for I18nizable texts */
035    public static final String PLUGIN_NAME = "plugin.extraction";
036    
037    /** Path of the directory containing definition files */ 
038    public static final String DEFINITIONS_DIR = BASE_DIR + "definitions/";
039    
040    /** Path of the directory containing stylesheets */ 
041    public static final String XSLT_DIR = BASE_DIR + "stylesheets/";
042    
043    /** Path of the directory containing pipelines definitions */ 
044    public static final String PIPELINES_DIR = BASE_DIR + "config/";
045    
046    /** Identifier of the description's content type */
047    public static final String DESCRIPTION_CONTENT_TYPE_ID = "org.ametys.plugins.extraction.Content.description";
048    
049    /** Name of the workflow used by description */
050    public static final String DESCRIPTION_CONTENT_WORKFLOW_NAME = "extraction-description";
051    
052    /** Identifier of the initial action of the description's workflow */
053    public static final int DESCRIPTION_CONTENT_INITIAL_ACTION_ID = 1;
054    
055    /** Message key for the description default title */
056    public static final String DESCRIPTION_DEFAULT_TITLE_KEY = "PLUGINS_EXTRACTION_CONTENT_DESCRIPTION_DEFAULT_TITLE";
057    
058    /** language of the description */
059    public static final String DESCRIPTION_LANGUAGE = "fr";
060    
061    /** extraction tag for definition file */
062    public static final String EXTRACTION_TAG = "extraction";
063    
064    /** description tag */
065    public static final String DESCRIPTION_TAG = "description";
066    
067    /** author tag */
068    public static final String AUTHOR_TAG = "author";
069    
070    /** description identifier attribute name */
071    public static final String DESCRIPTION_IDENTIFIER_ATTRIBUTE_NAME = "id";
072    
073    /** query component tag */
074    public static final String QUERY_COMPONENT_TAG = "query";
075    
076    /** thesaurus component tag */
077    public static final String THESAURUS_COMPONENT_TAG = "thesaurus";
078    
079    /** count component tag */
080    public static final String COUNT_COMPONENT_TAG = "count";
081    
082    /** mapping query component tag */
083    public static final String MAPPING_QUERY_COMPONENT_TAG = "mapping-query";
084    
085    /** clauses variables tag */
086    public static final String CLAUSES_VARIABLES_TAG = "clauses-variables";
087    
088    /** optional columns tag */
089    public static final String OPTIONAL_COLUMNS_TAG = "optional-columns";
090    
091    /** delimiter used in dialog inputs for string collections */
092    public static final String STRING_COLLECTIONS_INPUT_DELIMITER = ",";
093    
094    /** The directory under ametys home data directory for extraction results */
095    public static final String RESULT_EXTRACTION_DIR_NAME = "extraction";
096    
097    /** extraction tag for result file */
098    public static final String RESULT_EXTRACTION_TAG = "extraction";
099    
100    /** the path separator */
101    public static final String PATH_SEPARATOR = File.separator;
102}