FileSink.java

/*
 * Created on 2007/02/05
 * Copyright (C) 2007 Koga Laboratory. All rights reserved.
 *
 */
package org.mklab.tool.control.system.sink;

import java.io.IOException;

import org.mklab.nfc.matrix.ComplexNumericalMatrix;
import org.mklab.nfc.matrix.MatrixFileType;
import org.mklab.nfc.matrix.RealNumericalMatrix;
import org.mklab.nfc.scalar.ComplexNumericalScalar;
import org.mklab.nfc.scalar.RealNumericalScalar;


/**
 * ファイルへの出力器を表わすクラスです。
 * 
 * @author koga
 * @version $Revision: 1.8 $, 2007/02/05
 * @param <RS> type of real scalar
 * @param <RM> type of real matrix
 * @param <CS> type of complex scalar
 * @param <CM> type of complex matrix
 */
public class FileSink<RS extends RealNumericalScalar<RS,RM,CS,CM>, RM extends RealNumericalMatrix<RS,RM,CS,CM>, CS extends ComplexNumericalScalar<RS,RM,CS,CM>, CM extends ComplexNumericalMatrix<RS,RM,CS,CM>> extends MatrixExportSink<RS,RM,CS,CM> {

  /** 変数の名前 */
  private String variableName = "ans"; //$NON-NLS-1$

  /** ファイルの形式 */
  private MatrixFileType fileType = MatrixFileType.MX_DATA;

  /** ファイルの名前 */
  private String fileName = "ans" + this.fileType.getExtension(); //$NON-NLS-1$

  /**
   * 新しく生成された<code>FileSink</code>オブジェクトを初期化します。
   * @param sunit unit of scalar
   */
  public FileSink(RS sunit) {
    super(sunit);
  }

  /**
   * @see org.mklab.tool.control.system.sink.Exporter#close()
   */
  public void close() {
    // nothing
  }

  /**
   * @see org.mklab.tool.control.system.sink.Exporter#isActive()
   */
  public boolean isActive() {
    if (0 < getDataLength()) {
      return true;
    }
    return false;
  }

  /**
   * @see org.mklab.tool.control.system.sink.Exporter#exportData()
   */
  public void exportData() throws IOException {
//    final RM data = getData();
//
//    if (this.fileType == MatrixFileType.MX_DATA) {
//      data.writeMxFormat(new File(this.fileName), this.variableName);
//    } else if (this.fileType == MatrixFileType.MAT_DATA) {
//      data.writeMatFormat(new File(this.fileName));
//    } else if (this.fileType == MatrixFileType.MM_DATA) {
//      data.writeMmFormat(new File(this.fileName), this.variableName);
//    } else if (this.fileType == MatrixFileType.CSV_DATA) {
//      data.writeCsvFormat(new File(this.fileName));
//    } else {
      throw new IOException(Messages.getString("FileSink.2")); //$NON-NLS-1$
//    }
  }

  /**
   * ファイルの形式を設定します。
   * 
   * @param fileType ファイルの形式
   */
  public void setFileType(final MatrixFileType fileType) {
    this.fileType = fileType;
  }

  /**
   * ファイルの形式を返します。
   * 
   * @return ファイルの形式
   */
  public MatrixFileType getFileType() {
    return this.fileType;
  }

  /**
   * ファイルの名前を返します。
   * 
   * @return ファイルの名前
   */
  public String getFileName() {
    return this.fileName;
  }

  /**
   * ファイルの名前を設定します。 拡張子がない場合、ファイルの形式に対応する拡張子が追加されます。
   * 
   * @param fileName ファイルの名前
   */
  public void setFileName(final String fileName) {
    if (fileName.indexOf('.') == -1) {
      this.fileName = fileName + "." + this.fileType.getExtension(); //$NON-NLS-1$
    } else {
      this.fileName = fileName;
    }
  }

  /**
   * 変数の名前を返します。
   * 
   * @return 変数の名前
   */
  public String getVariableName() {
    return this.variableName;
  }

  /**
   * 変数の名前を設定します。
   * 
   * @param variableName 変数の名前
   */
  public void setVariableName(final String variableName) {
    this.variableName = variableName;
  }

  /**
   * @see org.mklab.tool.control.system.SystemOperator#equals(java.lang.Object)
   */
  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (!super.equals(o)) {
      return false;
    }
    if (o == null) {
      return false;
    }
    if (o.getClass() != getClass()) {
      return false;
    }
    FileSink<RS,RM,CS,CM> castedObj = (FileSink<RS,RM,CS,CM>)o;
    return ((this.variableName == null ? castedObj.variableName == null : this.variableName.equals(castedObj.variableName))
        && (this.fileType == null ? castedObj.fileType == null : this.fileType.equals(castedObj.fileType)) && (this.fileName == null ? castedObj.fileName == null : this.fileName
        .equals(castedObj.fileName)));
  }

  /**
   * @see org.mklab.tool.control.system.SystemOperator#hashCode()
   */
  @Override
  public int hashCode() {
    int hashCode = super.hashCode();
    hashCode = 31 * hashCode + (this.variableName == null ? 0 : this.variableName.hashCode());
    hashCode = 31 * hashCode + (this.fileType == null ? 0 : this.fileType.hashCode());
    hashCode = 31 * hashCode + (this.fileName == null ? 0 : this.fileName.hashCode());
    return hashCode;
  }
}