org.firebirdsql.jdbc.field.FBCachedClob Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jaybird-jdk17 Show documentation
JDBC Driver for the Firebird RDBMS
There is a newer version: 4.0.10.java7
/*
 * Firebird Open Source JavaEE Connector - JDBC Driver
 *
 * Distributable under LGPL license.
 * You may obtain a copy of the License at http://www.gnu.org/copyleft/lgpl.html
 *
 * 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
 * LGPL License for more details.
 *
 * This file was created by members of the firebird development team.
 * All individual contributions remain the Copyright (C) of those
 * individuals.  Contributors to this file are either listed here or
 * can be obtained from a source control history command.
 *
 * All rights reserved.
 */
package org.firebirdsql.jdbc.field;

import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.io.Reader;
import java.io.Writer;
import java.sql.Clob;
import java.sql.NClob;
import java.sql.SQLException;

import org.firebirdsql.jdbc.FBCachedBlob;
import org.firebirdsql.jdbc.FBDriverNotCapableException;
import org.firebirdsql.jdbc.FBSQLException;

/**
 * Clob implementation that is cached client-side.
 * 
 * This implementation is used for disconnected result sets (ie scrollable and hold cursors over commit).
 * 
 * 
 * This class also implements {@link NClob} so it can be used with the {@code set/get/updateNClob} methods
 * transparently. It technically does not conform to the JDBC requirements for {@code NClob}.
 * 
 */
public class FBCachedClob implements Clob, NClob {
	
	private FBCachedBlob wrappedBlob;
	private String javaEncoding;

	public FBCachedClob(FBCachedBlob blob, String javaEncoding) {
		this.wrappedBlob = blob;
		this.javaEncoding = javaEncoding;
	}

	public void free() throws SQLException {
		wrappedBlob.free();
	}

	public InputStream getAsciiStream() throws SQLException {
		return wrappedBlob.getBinaryStream();
	}

	public Reader getCharacterStream() throws SQLException {
		InputStream inputStream = wrappedBlob.getBinaryStream();
		if (javaEncoding == null) {
			return new InputStreamReader(inputStream);
		} else {
			try {
				return new InputStreamReader(wrappedBlob.getBinaryStream(),
						javaEncoding);
			} catch (IOException ioe) {
				throw new FBSQLException(ioe);
			}
		}
	}

	public Reader getCharacterStream(long pos, long length) throws SQLException {
		InputStream inputStream = wrappedBlob.getBinaryStream(pos, length);
		if (javaEncoding == null) {
			return new InputStreamReader(inputStream);
		} else {
			try {
				return new InputStreamReader(inputStream, javaEncoding);
			} catch (IOException ioe) {
				throw new FBSQLException(ioe);
			}
		}
	}

	public String getSubString(long pos, int length) throws SQLException {
		throw new FBDriverNotCapableException("Method getSubstring(long, int) is not supported");
	}

	public long length() throws SQLException {
		throw new FBDriverNotCapableException("Cannot determine length for CLOB");
	}

	public long position(String searchstr, long start) throws SQLException {
		throw new FBDriverNotCapableException("Method position(String, long) is not supported");
	}

	public long position(Clob searchstr, long start) throws SQLException {
		throw new FBDriverNotCapableException("Method position(Clob, long) is not supported");
	}

	public OutputStream setAsciiStream(long pos) throws SQLException {
		throw new FBSQLException("Clob in auto-commit mode is read-only.");
	}

	public Writer setCharacterStream(long pos) throws SQLException {
		throw new FBSQLException("Clob in auto-commit mode is read-only.");
	}

	public int setString(long pos, String str) throws SQLException {
		throw new FBSQLException("Clob in auto-commit mode is read-only.");
	}

	public int setString(long pos, String str, int offset, int len)
			throws SQLException {
		throw new FBSQLException("Clob in auto-commit mode is read-only.");
	}

	public void truncate(long len) throws SQLException {
		wrappedBlob.truncate(len);
	}

}