/*
* Copyright (C) 2006-2016 DLR, Germany
*
* All rights reserved
*
* http://www.rcenvironment.de/
*/
package de.rcenvironment.components.outputwriter.common;
import de.rcenvironment.core.component.api.ComponentConstants;
/**
* Constants for OutputWriter.
*
* @author Hendrik Abbenhaus
* @author Sascha Zur
* @author Brigitte Boden
*
*/
public final class OutputWriterComponentConstants {
/** Identifier of Output Writer component. */
public static final String COMPONENT_ID = ComponentConstants.COMPONENT_IDENTIFIER_PREFIX + "outputwriter";
/** placeholder prefix. */
public static final String PH_PREFIX = "[";
/** placeholder suffix. */
public static final String PH_SUFFIX = "]";
/** placeholder delimiter. */
public static final String PH_DELIM = " - ";
/** inputname without prefix and suffix. */
public static final String INPUTNAME = "Input name";
/** placeholder inputname. */
public static final String PH_INPUTNAME = PH_PREFIX + INPUTNAME + PH_SUFFIX;
/** placeholder workflowname. */
public static final String PH_WORKFLOWNAME = PH_PREFIX + "Workflow name" + PH_SUFFIX;
/** Execution count. */
public static final String EXECUTION_COUNT = "Execution count";
/** placeholder execution count. */
public static final String PH_EXECUTION_COUNT = PH_PREFIX + EXECUTION_COUNT + PH_SUFFIX;
/** filename. */
public static final String FILE_NAME = "Original filename";
/** placeholder filename. */
public static final String PH_FILE_NAME = PH_PREFIX + FILE_NAME + PH_SUFFIX;
/** placeholder timestamp. */
public static final String TIMESTAMP = "Timestamp";
/** placeholder timestamp. */
public static final String PH_TIMESTAMP = PH_PREFIX + TIMESTAMP + PH_SUFFIX;
/** placeholder linebreak. */
public static final String LINEBREAK = "Linebreak";
/** placeholder linebreak. */
public static final String PH_LINEBREAK = PH_PREFIX + LINEBREAK + PH_SUFFIX;
/** placeholder wf timestamp. */
public static final String PH_WF_START_TS = PH_PREFIX + "Timestamp at workflow start" + PH_SUFFIX;
/** placeholder component name. */
public static final String PH_COMP_NAME = PH_PREFIX + "Component name" + PH_SUFFIX;
/** placeholder component type. */
public static final String PH_COMP_TYPE = PH_PREFIX + "Component type" + PH_SUFFIX;
/** All Placeholders. */
public static final String[] WORDLIST = new String[] { PH_COMP_NAME, PH_INPUTNAME, PH_TIMESTAMP, PH_WF_START_TS, PH_WORKFLOWNAME,
PH_EXECUTION_COUNT , PH_FILE_NAME};
/** All Placeholders for sub folders. */
public static final String[] WORDLIST_SUBFOLDER = new String[] { PH_COMP_NAME, PH_INPUTNAME, PH_WF_START_TS,
PH_WORKFLOWNAME };
/** All Placeholders for Output Locations. */
public static final String[] WORDLIST_OUTPUT = new String[] { PH_COMP_NAME, PH_WF_START_TS, PH_WORKFLOWNAME };
/** Constant. */
public static final String ROOT_DISPLAY_NAME = PH_PREFIX + "root" + PH_SUFFIX;
/** You can not create Files with these names. */
public static final String[] PROBLEMATICFILENAMES_WIN = new String[] {
"CON", "PRN", "AUX", "NUL", "COM1", "COM2", "COM3", "COM4", "COM5",
"COM6", "COM7", "COM8", "COM9", "LPT1", "LPT2", "LPT3", "LPT4",
"LPT5", "LPT6", "LPT7", "LPT8", "LPT9" };
/** PropertyName of selected Root. */
public static final String CONFIG_KEY_ROOT = "SelectedRoot";
/** PropertyName of the writePath. */
public static final String CONFIG_KEY_ONWFSTART_ROOT = "OWWritePath";
/** PropertyName of OnWFStart. */
public static final String CONFIG_KEY_ONWFSTART = "SelectRootOnWorkflowStart";
/** Constant. */
public static final String CONFIG_KEY_BEHAVIOUR = "ifexist";
/** Constant. */
public static final String CONFIG_KEY_INPUTS = "inputs";
/** Constant. */
public static final String CONFIG_KEY_TYPE = "type";
/** Constant. */
public static final String CONFIG_KEY_PATH = "path";
/** Constant. */
public static final String CONFIG_KEY_FOLDERFORSAVING = "folderForSaving";
/** Constant. */
public static final String CONFIG_KEY_FILENAME = "filename";
/** Constant. */
public static final String CONFIG_KEY_OUTPUTLOCATIONS = "outputLocations";
/** Constant. */
public static final String EP_IDENTIFIER = "dynamicAndGroup";
/** Constant. */
public static final String DEFAULT_GROUP = "write";
/**
* How to handle an existing file.
*
*/
public enum HandleExistingFile {
/**
* Append to existing file.
*/
APPEND,
/**
* Override existing file.
*/
OVERRIDE,
/**
* Change filename of new file.
*/
AUTORENAME
}
/**
* Default value for handle existing file (for Outputlocations).
*/
public static final HandleExistingFile DEFAULT_HANDLE_EXISTING_FILE = HandleExistingFile.APPEND;
private OutputWriterComponentConstants() {
}
}