Package org.postgresql.jdbc

Class PgArray

java.lang.Object

org.postgresql.jdbc.PgArray

All Implemented Interfaces:

Array

public class PgArray
extends Object
implements Array

Array is used collect one column of query result data.

Read a field of type Array into either a natively-typed Java array object or a ResultSet. Accessor methods provide the ability to capture array slices.

Other than the constructor all methods are direct implementations of those specified for java.sql.Array. Please refer to the javadoc for java.sql.Array for detailed descriptions of the functionality and parameters of the methods of this class.

See Also:

• ResultSet.getArray(int)

Field Summary

Fields

Modifier and Type	Field	Description
protected ArrayDecoding.PgArrayList	arrayList	Value of field as ArrayDecoding.PgArrayList.
protected BaseConnection	connection	A database connection.
protected byte[]	fieldBytes
protected String	fieldString	Field value as String.
private final ResourceLock	lock
private final int	oid	The OID of this field.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	PgArray(BaseConnection connection, int oid)
	PgArray(BaseConnection connection, int oid, byte[] fieldBytes)	Create a new Array.
	PgArray(BaseConnection connection, int oid, String fieldString)	Create a new Array.

Method Summary

Modifier and Type	Method	Description
private Object	buildArray(ArrayDecoding.PgArrayList input, int index, int count)	Convert ArrayList to array.
private ArrayDecoding.PgArrayList	buildArrayList(String fieldString)	Build ArrayList from field's string input.
private static int	calcRemainingDataLength(byte[] fieldBytes, int[] dims, int pos, int elementOid, int thisDimension)
static void	escapeArrayElement(StringBuilder b, String s)
void	free()
Object	getArray()
Object	getArray(long index, int count)
Object	getArray(long index, int count, Map<String,Class<?>> map)
Object	getArray(Map<String,Class<?>> map)
Object	getArrayImpl(long index, int count, Map<String,Class<?>> map)
Object	getArrayImpl(Map<String,Class<?>> map)
int	getBaseType()
String	getBaseTypeName()
private BaseConnection	getConnection()
ResultSet	getResultSet()
ResultSet	getResultSet(long index, int count)
ResultSet	getResultSet(long index, int count, Map<String,Class<?>> map)
ResultSet	getResultSet(Map<String,Class<?>> map)
ResultSet	getResultSetImpl(long index, int count, Map<String,Class<?>> map)
ResultSet	getResultSetImpl(Map<String,Class<?>> map)
boolean	isBinary()
private Object	readBinaryArray(byte[] fieldBytes, int index, int count)
private ResultSet	readBinaryResultSet(byte[] fieldBytes, int index, int count)
private int	storeValues(byte[] fieldBytes, List<Tuple> rows, Field[] fields, int elementOid, int[] dims, int pos, int thisDimension, int index)
byte[]	toBytes()
String	toString()
private String	toString(ArrayDecoding.PgArrayList list)	Convert array list to PG String representation (e.g.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

connection

protected BaseConnection connection

A database connection.

oid

private final int oid

The OID of this field.

fieldString

protected String fieldString

Field value as String.

arrayList

protected ArrayDecoding.PgArrayList arrayList

Value of field as ArrayDecoding.PgArrayList. Will be initialized only once within buildArrayList(String).

fieldBytes

protected byte[] fieldBytes

lock

private final ResourceLock lock

Constructor Details

PgArray

private PgArray(BaseConnection connection,
 int oid)
         throws SQLException

Throws:

SQLException

PgArray

public PgArray(BaseConnection connection,
 int oid,
 String fieldString)
        throws SQLException

Create a new Array.

Parameters:

connection - a database connection

oid - the oid of the array datatype

fieldString - the array data in string form

Throws:

SQLException - if something wrong happens

PgArray

public PgArray(BaseConnection connection,
 int oid,
 byte[] fieldBytes)
        throws SQLException

Create a new Array.

Parameters:

connection - a database connection

oid - the oid of the array datatype

fieldBytes - the array data in byte form

Throws:

SQLException - if something wrong happens

Method Details

getConnection

private BaseConnection getConnection()

getArray

public Object getArray()
                throws SQLException

Specified by:

getArray in interface Array

Throws:

SQLException

getArray

public Object getArray(long index,
 int count)
                throws SQLException

Specified by:

getArray in interface Array

Throws:

SQLException

getArrayImpl

public Object getArrayImpl(Map<String,Class<?>> map)
                    throws SQLException

Throws:

SQLException

getArray

public Object getArray(Map<String,Class<?>> map)
                throws SQLException

Specified by:

getArray in interface Array

Throws:

SQLException

getArray

public Object getArray(long index,
 int count,
 Map<String,Class<?>> map)
                throws SQLException

Specified by:

getArray in interface Array

Throws:

SQLException

getArrayImpl

public Object getArrayImpl(long index,
 int count,
 Map<String,Class<?>> map)
                    throws SQLException

Throws:

SQLException

readBinaryArray

private Object readBinaryArray(byte[] fieldBytes,
 int index,
 int count)
                        throws SQLException

Throws:

SQLException

readBinaryResultSet

private ResultSet readBinaryResultSet(byte[] fieldBytes,
 int index,
 int count)
                               throws SQLException

Throws:

SQLException

storeValues

private int storeValues(byte[] fieldBytes,
 List<Tuple> rows,
 Field[] fields,
 int elementOid,
 int[] dims,
 int pos,
 int thisDimension,
 int index)
                 throws SQLException

Throws:

SQLException

calcRemainingDataLength

private static int calcRemainingDataLength(byte[] fieldBytes,
 int[] dims,
 int pos,
 int elementOid,
 int thisDimension)

buildArrayList

private ArrayDecoding.PgArrayList buildArrayList(String fieldString)
                                          throws SQLException

Build ArrayList from field's string input. As a result of this method arrayList is build. Method can be called many times in order to make sure that array list is ready to use, however arrayList will be set only once during first call.

Throws:

SQLException

buildArray

private Object buildArray(ArrayDecoding.PgArrayList input,
 int index,
 int count)
                   throws SQLException

Convert ArrayList to array.

Parameters:

input - list to be converted into array

Throws:

SQLException

getBaseType

public int getBaseType()
                throws SQLException

Specified by:

getBaseType in interface Array

Throws:

SQLException

getBaseTypeName

public String getBaseTypeName()
                       throws SQLException

Specified by:

getBaseTypeName in interface Array

Throws:

SQLException

getResultSet

public ResultSet getResultSet()
                       throws SQLException

Specified by:

getResultSet in interface Array

Throws:

SQLException

getResultSet

public ResultSet getResultSet(long index,
 int count)
                       throws SQLException

Specified by:

getResultSet in interface Array

Throws:

SQLException

getResultSet

public ResultSet getResultSet(Map<String,Class<?>> map)
                       throws SQLException

Specified by:

getResultSet in interface Array

Throws:

SQLException

getResultSet

public ResultSet getResultSet(long index,
 int count,
 Map<String,Class<?>> map)
                       throws SQLException

Specified by:

getResultSet in interface Array

Throws:

SQLException

getResultSetImpl

public ResultSet getResultSetImpl(Map<String,Class<?>> map)
                           throws SQLException

Throws:

SQLException

getResultSetImpl

public ResultSet getResultSetImpl(long index,
 int count,
 Map<String,Class<?>> map)
                           throws SQLException

Throws:

SQLException

toString

public String toString()

Overrides:

toString in class Object

toString

private String toString(ArrayDecoding.PgArrayList list)
                 throws SQLException

Convert array list to PG String representation (e.g. {0,1,2}).

Throws:

SQLException

escapeArrayElement

public static void escapeArrayElement(StringBuilder b,
 String s)

isBinary

public boolean isBinary()

toBytes

public byte[] toBytes()

free

public void free()
          throws SQLException

Specified by:

free in interface Array

Throws:

SQLException