core/org.eclipse.stem.loggers.csv/src/org/eclipse/stem/loggers/csv/CSVLogger.java

/******************************************************************************
 * Copyright (c) 2011 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.stem.loggers.csv;

import org.eclipse.stem.loggers.SynchronousDecoratorPropertyLogger;

/**
 * <!-- begin-user-doc -->
 * A representation of the model object '<em><b>Logger</b></em>'.
 * <!-- end-user-doc -->
 *
 * <p>
 * The following features are supported:
 * <ul>
 *   <li>{@link org.eclipse.stem.loggers.csv.CSVLogger#isUseDefaultLogDirectory <em>Use Default Log Directory</em>}</li>
 *   <li>{@link org.eclipse.stem.loggers.csv.CSVLogger#getDataPath <em>Data Path</em>}</li>
 *   <li>{@link org.eclipse.stem.loggers.csv.CSVLogger#getDelimeter <em>Delimeter</em>}</li>
 *   <li>{@link org.eclipse.stem.loggers.csv.CSVLogger#isLogRunParameters <em>Log Run Parameters</em>}</li>
 *   <li>{@link org.eclipse.stem.loggers.csv.CSVLogger#getBufferSize <em>Buffer Size</em>}</li>
 * </ul>
 * </p>
 *
 * @see org.eclipse.stem.loggers.csv.CSVPackage#getCSVLogger()
 * @model
 * @generated
 */
public interface CSVLogger extends SynchronousDecoratorPropertyLogger {
	/**
	 * Returns the value of the '<em><b>Use Default Log Directory</b></em>' attribute.
	 * The default value is <code>"true"</code>.
	 * <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Use Default Log Directory</em>' attribute isn't clear,
	 * there really should be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * @return the value of the '<em>Use Default Log Directory</em>' attribute.
	 * @see #setUseDefaultLogDirectory(boolean)
	 * @see org.eclipse.stem.loggers.csv.CSVPackage#getCSVLogger_UseDefaultLogDirectory()
	 * @model default="true"
	 * @generated
	 */
	boolean isUseDefaultLogDirectory();

	/**
	 * Sets the value of the '{@link org.eclipse.stem.loggers.csv.CSVLogger#isUseDefaultLogDirectory <em>Use Default Log Directory</em>}' attribute.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @param value the new value of the '<em>Use Default Log Directory</em>' attribute.
	 * @see #isUseDefaultLogDirectory()
	 * @generated
	 */
	void setUseDefaultLogDirectory(boolean value);

	/**
	 * Returns the value of the '<em><b>Data Path</b></em>' attribute.
	 * <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Data Path</em>' attribute isn't clear,
	 * there really should be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * @return the value of the '<em>Data Path</em>' attribute.
	 * @see #setDataPath(String)
	 * @see org.eclipse.stem.loggers.csv.CSVPackage#getCSVLogger_DataPath()
	 * @model
	 * @generated
	 */
	String getDataPath();

	/**
	 * Sets the value of the '{@link org.eclipse.stem.loggers.csv.CSVLogger#getDataPath <em>Data Path</em>}' attribute.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @param value the new value of the '<em>Data Path</em>' attribute.
	 * @see #getDataPath()
	 * @generated
	 */
	void setDataPath(String value);

	/**
	 * Returns the value of the '<em><b>Delimeter</b></em>' attribute.
	 * The default value is <code>","</code>.
	 * <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Delimeter</em>' attribute isn't clear,
	 * there really should be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * @return the value of the '<em>Delimeter</em>' attribute.
	 * @see #setDelimeter(String)
	 * @see org.eclipse.stem.loggers.csv.CSVPackage#getCSVLogger_Delimeter()
	 * @model default=","
	 * @generated
	 */
	String getDelimeter();

	/**
	 * Sets the value of the '{@link org.eclipse.stem.loggers.csv.CSVLogger#getDelimeter <em>Delimeter</em>}' attribute.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @param value the new value of the '<em>Delimeter</em>' attribute.
	 * @see #getDelimeter()
	 * @generated
	 */
	void setDelimeter(String value);

	/**
	 * Returns the value of the '<em><b>Log Run Parameters</b></em>' attribute.
	 * The default value is <code>"true"</code>.
	 * <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Log Run Parameters</em>' attribute isn't clear,
	 * there really should be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * @return the value of the '<em>Log Run Parameters</em>' attribute.
	 * @see #setLogRunParameters(boolean)
	 * @see org.eclipse.stem.loggers.csv.CSVPackage#getCSVLogger_LogRunParameters()
	 * @model default="true"
	 * @generated
	 */
	boolean isLogRunParameters();

	/**
	 * Sets the value of the '{@link org.eclipse.stem.loggers.csv.CSVLogger#isLogRunParameters <em>Log Run Parameters</em>}' attribute.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @param value the new value of the '<em>Log Run Parameters</em>' attribute.
	 * @see #isLogRunParameters()
	 * @generated
	 */
	void setLogRunParameters(boolean value);

	/**
	 * Returns the value of the '<em><b>Buffer Size</b></em>' attribute.
	 * The default value is <code>"1024"</code>.
	 * <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Buffer Size</em>' attribute isn't clear,
	 * there really should be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * @return the value of the '<em>Buffer Size</em>' attribute.
	 * @see #setBufferSize(int)
	 * @see org.eclipse.stem.loggers.csv.CSVPackage#getCSVLogger_BufferSize()
	 * @model default="1024"
	 * @generated
	 */
	int getBufferSize();

	/**
	 * Sets the value of the '{@link org.eclipse.stem.loggers.csv.CSVLogger#getBufferSize <em>Buffer Size</em>}' attribute.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @param value the new value of the '<em>Buffer Size</em>' attribute.
	 * @see #getBufferSize()
	 * @generated
	 */
	void setBufferSize(int value);

} // CSVLogger