/* Copyright (c) 2001-2008, The HSQL Development Group
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* Neither the name of the HSQL Development Group nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL HSQL DEVELOPMENT GROUP, HSQLDB.ORG,
* OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.hsqldb.rowio;
import java.io.UnsupportedEncodingException;
import java.math.BigDecimal;
import java.sql.Date;
import java.sql.Time;
import java.sql.Timestamp;
import org.hsqldb.CachedRow;
import org.hsqldb.Trace;
import org.hsqldb.Types;
import org.hsqldb.lib.StringConverter;
import org.hsqldb.persist.TextCache;
import org.hsqldb.types.Binary;
import org.hsqldb.types.JavaObject;
/**
* Class for writing the data for a database row in text table format.
*
* @author sqlbob@users (RMP)
* @version 1.8.0
* @since 1.7.0
*/
public class RowOutputText extends RowOutputBase {
protected String fieldSep;
protected String varSep;
protected String longvarSep;
private boolean fieldSepEnd;
private boolean varSepEnd;
private boolean longvarSepEnd;
private String nextSep = "";
private boolean nextSepEnd;
protected boolean allQuoted;
private String encoding;
public RowOutputText(String fieldSep, String varSep, String longvarSep,
boolean allQuoted, String encoding) {
super();
initTextDatabaseRowOutput(fieldSep, varSep, longvarSep, allQuoted,
encoding);
}
private void initTextDatabaseRowOutput(String fieldSep, String varSep,
String longvarSep,
boolean allQuoted,
String encoding) {
//-- Newline indicates that field should match to end of line.
if (fieldSep.endsWith("\n")) {
fieldSepEnd = true;
fieldSep = fieldSep.substring(0, fieldSep.length() - 1);
}
if (varSep.endsWith("\n")) {
varSepEnd = true;
varSep = varSep.substring(0, varSep.length() - 1);
}
if (longvarSep.endsWith("\n")) {
longvarSepEnd = true;
longvarSep = longvarSep.substring(0, longvarSep.length() - 1);
}
this.fieldSep = fieldSep;
this.varSep = varSep;
this.longvarSep = longvarSep;
this.allQuoted = allQuoted;
this.encoding = encoding;
}
public void writeEnd() {
// terminate at the end of row
if (nextSepEnd) {
writeBytes(nextSep);
}
writeBytes(TextCache.NL);
}
public void writeSize(int size) {
// initialise at the start of row
nextSep = "";
nextSepEnd = false;
}
public void writeType(int type) {
//--do Nothing
}
public void writeString(String s) {
s = checkConvertString(s, fieldSep);
// error
if (s == null) {
return;
}
// writeBytes(s);
byte[] bytes = getBytes(s);
write(bytes, 0, bytes.length);
nextSep = fieldSep;
nextSepEnd = fieldSepEnd;
}
protected void writeVarString(String s) {
s = checkConvertString(s, varSep);
if (s == null) {
return;
}
// writeBytes(s);
byte[] bytes = getBytes(s);
write(bytes, 0, bytes.length);
nextSep = varSep;
nextSepEnd = varSepEnd;
}
protected void writeLongVarString(String s) {
s = checkConvertString(s, longvarSep);
if (s == null) {
return;
}
// writeBytes(s);
byte[] bytes = getBytes(s);
write(bytes, 0, bytes.length);
nextSep = longvarSep;
nextSepEnd = longvarSepEnd;
}
protected String checkConvertString(String s, String sep) {
if (s.indexOf('\n') != -1 || s.indexOf('\r') != -1) {
throw new IllegalArgumentException(
Trace.getMessage(Trace.TEXT_STRING_HAS_NEWLINE));
} else if (s.indexOf(sep) != -1) {
return null;
}
return s;
}
private byte[] getBytes(String s) {
byte[] bytes = null;
try {
bytes = s.getBytes(encoding);
} catch (UnsupportedEncodingException e) {
bytes = s.getBytes();
}
return bytes;
}
protected void writeByteArray(byte[] b) {
ensureRoom(b.length * 2);
StringConverter.writeHex(this.getBuffer(), count, b);
count += b.length * 2;
}
public void writeShortData(short i) {
writeIntData(i);
}
public void writeIntData(int i) {
writeBytes(Integer.toString(i));
nextSep = fieldSep;
nextSepEnd = fieldSepEnd;
}
public void writeIntData(int i, int position) {
throw Trace.runtimeError(Trace.UNSUPPORTED_INTERNAL_OPERATION,
"RowInputText");
}
public void writeLongData(long i) {
throw Trace.runtimeError(Trace.UNSUPPORTED_INTERNAL_OPERATION,
"RowInputText");
}
// fredt@users - comment - methods used for writing each SQL type
protected void writeFieldType(int type) {
writeBytes(nextSep);
switch (type) {
case Types.VARCHAR :
case Types.VARCHAR_IGNORECASE :
nextSep = varSep;
nextSepEnd = varSepEnd;
break;
case Types.LONGVARCHAR :
nextSep = longvarSep;
nextSepEnd = longvarSepEnd;
break;
default :
nextSep = fieldSep;
nextSepEnd = fieldSepEnd;
break;
}
}
protected void writeNull(int type) {
writeFieldType(type);
}
protected void writeChar(String s, int t) {
switch (t) {
case Types.CHAR :
writeString(s);
return;
case Types.VARCHAR :
case Types.VARCHAR_IGNORECASE :
writeVarString(s);
return;
case Types.LONGVARCHAR :
default :
writeLongVarString(s);
return;
}
}
protected void writeSmallint(Number o) {
writeString(o.toString());
}
protected void writeInteger(Number o) {
writeString(o.toString());
}
protected void writeBigint(Number o) {
writeString(o.toString());
}
protected void writeReal(Double o, int type) {
writeString(o.toString());
}
protected void writeDecimal(BigDecimal o) {
writeString(o.toString());
}
protected void writeBit(Boolean o) {
writeString(o.toString());
}
protected void writeDate(Date o) {
writeString(o.toString());
}
protected void writeTime(Time o) {
writeString(o.toString());
}
protected void writeTimestamp(Timestamp o) {
writeString(o.toString());
}
protected void writeOther(JavaObject o) {
byte[] ba = o.getBytes();
writeByteArray(ba);
}
protected void writeBinary(Binary o, int t) {
writeByteArray(o.getBytes());
}
public int getSize(CachedRow r) {
reset();
try {
writeSize(0);
writeData(r.getData(), r.getTable());
writeEnd();
} catch (Exception e) {
reset();
// throw (Trace.error(Trace.FILE_IO_ERROR, e.toString()));
}
int rowsize = size();
reset();
return rowsize;
}
}