summaryrefslogtreecommitdiff
path: root/src/de/lmu/ifi/dbs/elki/result/textwriter/SingleStreamOutput.java
blob: 1e4e577334cc8edf99c1a852d4ab359a658cfbef (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
package de.lmu.ifi.dbs.elki.result.textwriter;

/*
 This file is part of ELKI:
 Environment for Developing KDD-Applications Supported by Index-Structures

 Copyright (C) 2011
 Ludwig-Maximilians-Universität München
 Lehr- und Forschungseinheit für Datenbanksysteme
 ELKI Development Team

 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Affero General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU Affero General Public License for more details.

 You should have received a copy of the GNU Affero General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

import java.io.File;
import java.io.FileDescriptor;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.io.PrintStream;
import java.util.zip.GZIPOutputStream;

/**
 * Class to output all result data to a single stream (e.g. Stdout, single file)
 * 
 * @author Erich Schubert
 *
 */
public class SingleStreamOutput implements StreamFactory {
  /**
   * Output stream
   */
  private PrintStream stream;
  
  /**
   * Constructor using stdout.
   * @throws IOException on IO error
   */
  public SingleStreamOutput() throws IOException  {
    this(FileDescriptor.out);
  }
  
  /**
   * Constructor using stdout
   * 
   * @param gzip Use gzip compression
   * @throws IOException on IO error
   */
  public SingleStreamOutput(boolean gzip) throws IOException  {
    this(FileDescriptor.out, gzip);
  }
  
  /**
   * Constructor with given file name.
   * 
   * @param out filename
   * @throws IOException on IO error
   */
  public SingleStreamOutput(File out) throws IOException {
    this(new FileOutputStream(out));
  }

  /**
   * Constructor with given file name.
   * 
   * @param out filename
   * @param gzip Use gzip compression
   * @throws IOException on IO error
   */
  public SingleStreamOutput(File out, boolean gzip) throws IOException {
    this(new FileOutputStream(out), gzip);
  }

  /**
   * Constructor with given FileDescriptor
   * 
   * @param out file descriptor
   * @throws IOException on IO error
   */
  public SingleStreamOutput(FileDescriptor out) throws IOException {
    this(new FileOutputStream(out));
  }
  
  /**
   * Constructor with given FileDescriptor
   * 
   * @param out file descriptor
   * @param gzip Use gzip compression
   * @throws IOException on IO error
   */
  public SingleStreamOutput(FileDescriptor out, boolean gzip) throws IOException {
    this(new FileOutputStream(out), gzip);
  }
  
  /**
   * Constructor with given FileOutputStream.
   * 
   * @param out File output stream
   * @throws IOException on IO error
   */
  public SingleStreamOutput(FileOutputStream out) throws IOException {
    this(out, false);
  }

  /**
   * Constructor with given FileOutputStream.
   * 
   * @param out File output stream
   * @param gzip Use gzip compression
   * @throws IOException on IO error
   */
  public SingleStreamOutput(FileOutputStream out, boolean gzip) throws IOException {
    OutputStream os = out;
    if (gzip) {
      // wrap into gzip stream.
      os = new GZIPOutputStream(os);
    }
    this.stream = new PrintStream(os);
  }

  /**
   * Return the objects shared print stream.
   * 
   * @param filename ignored filename for SingleStreamOutput, as the name suggests
   */
  @Override
  public PrintStream openStream(String filename) {
    return stream;
  }

  /**
   * Close output stream.
   */
  @Override
  public void closeAllStreams() {
    stream.close();
  }
}