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
018/**
019 * Constants related to extraction.
020 */
021public interface ExtractionConstants
022{
023    /** Right id to execute extractions */
024    public static final String EXECUTE_EXTRACTION_RIGHT_ID = "Extraction_Rights_ExecuteExtraction";
025    
026    /** Right id to modify extractions */
027    public static final String MODIFY_EXTRACTION_RIGHT_ID = "Extraction_Rights_EditExtraction";
028    
029    /** Path of the base directory for extraction files */
030    public static final String BASE_DIR = "context://WEB-INF/param/extraction/";
031    
032    /** Plugin name to use for I18nizable texts */
033    public static final String PLUGIN_NAME = "plugin.extraction";
034    
035    /** Path of the directory containing definition files */ 
036    public static final String DEFINITIONS_DIR = BASE_DIR + "definitions/";
037    
038    /** Path of the directory containing stylesheets */ 
039    public static final String XSLT_DIR = BASE_DIR + "stylesheets/";
040    
041    /** Path of the directory containing pipelines definitions */ 
042    public static final String PIPELINES_DIR = BASE_DIR + "config/";
043    
044    /** Identifier of the description's content type */
045    public static final String DESCRIPTION_CONTENT_TYPE_ID = "org.ametys.plugins.extraction.Content.description";
046    
047    /** Name of the workflow used by description */
048    public static final String DESCRIPTION_CONTENT_WORKFLOW_NAME = "extraction-description";
049    
050    /** Identifier of the initial action of the description's workflow */
051    public static final int DESCRIPTION_CONTENT_INITIAL_ACTION_ID = 1;
052    
053    /** Message key for the description default title */
054    public static final String DESCRIPTION_DEFAULT_TITLE_KEY = "PLUGINS_EXTRACTION_CONTENT_DESCRIPTION_DEFAULT_TITLE";
055    
056    /** language of the description */
057    public static final String DESCRIPTION_LANGUAGE = "fr";
058    
059    /** extraction tag for definition file */
060    public static final String EXTRACTION_TAG = "extraction";
061    
062    /** description tag */
063    public static final String DESCRIPTION_TAG = "description";
064    
065    /** visibility tag */
066    public static final String VISIBILITY_TAG = "visibility";
067    
068    /** author tag */
069    public static final String AUTHOR_TAG = "author";
070    
071    /** read access profile tag */
072    public static final String READ_ACCESS_TAG = "read-access";
073    
074    /** write access profile tag */
075    public static final String WRITE_ACCESS_TAG = "write-access";
076    
077    /** groups tag, used for granted groups */
078    public static final String GROUPS_TAG = "groups";
079    
080    /** group tag, used for a granted group */
081    public static final String GROUP_TAG = "group";
082    
083    /** users tag, used for granted users */
084    public static final String USERS_TAG = "users";
085    
086    /** user tag, used for a granted user */
087    public static final String USER_TAG = "user";
088    
089    /** description identifier attribute name */
090    public static final String DESCRIPTION_IDENTIFIER_ATTRIBUTE_NAME = "id";
091    
092    /** query component tag */
093    public static final String QUERY_COMPONENT_TAG = "query";
094    
095    /** thesaurus component tag */
096    public static final String THESAURUS_COMPONENT_TAG = "thesaurus";
097    
098    /** count component tag */
099    public static final String COUNT_COMPONENT_TAG = "count";
100    
101    /** mapping query component tag */
102    public static final String MAPPING_QUERY_COMPONENT_TAG = "mapping-query";
103    
104    /** clauses variables tag */
105    public static final String CLAUSES_VARIABLES_TAG = "clauses-variables";
106    
107    /** optinal columns tag */
108    public static final String OPTIONAL_COLUMNS_TAG = "optional-columns";
109    
110    /** delimiter used in dialog inputs for string collections */
111    public static final String STRING_COLLECTIONS_INPUT_DELIMITER = ",";
112    
113    /** The directory under ametys home data directory for extraction results */
114    public static final String RESULT_EXTRACTION_DIR_NAME = "extraction";
115    
116    /** extraction tag for result file */
117    public static final String RESULT_EXTRACTION_TAG = "extraction";
118}