Package org.postgresql.jdbc

Class PgArray

  • All Implemented Interfaces:
    java.sql.Array
    public class PgArray
extends java.lang.Object
implements java.sql.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 org.postgresql.jdbc.ArrayDecoding.PgArrayList arrayList
      Value of field as ArrayDecoding.PgArrayList.
      protected BaseConnection connection
      A database connection.
      protected byte[] fieldBytes  
      protected java.lang.String fieldString
      Field value as String.

    • Constructor Summary

      Constructors 
      Constructor Description
      PgArray​(BaseConnection connection, int oid, byte[] fieldBytes)
      Create a new Array.
      PgArray​(BaseConnection connection, int oid, java.lang.String fieldString)
      Create a new Array.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static void escapeArrayElement​(java.lang.StringBuilder b, java.lang.String s)  
      void free()  
      java.lang.Object getArray()  
      java.lang.Object getArray​(long index, int count)  
      java.lang.Object getArray​(long index, int count, java.util.Map<java.lang.String,​java.lang.Class<?>> map)  
      java.lang.Object getArray​(java.util.Map<java.lang.String,​java.lang.Class<?>> map)  
      java.lang.Object getArrayImpl​(long index, int count, java.util.Map<java.lang.String,​java.lang.Class<?>> map)  
      java.lang.Object getArrayImpl​(java.util.Map<java.lang.String,​java.lang.Class<?>> map)  
      int getBaseType()  
      java.lang.String getBaseTypeName()  
      java.sql.ResultSet getResultSet()  
      java.sql.ResultSet getResultSet​(long index, int count)  
      java.sql.ResultSet getResultSet​(long index, int count, java.util.Map<java.lang.String,​java.lang.Class<?>> map)  
      java.sql.ResultSet getResultSet​(java.util.Map<java.lang.String,​java.lang.Class<?>> map)  
      java.sql.ResultSet getResultSetImpl​(long index, int count, java.util.Map<java.lang.String,​java.lang.Class<?>> map)  
      java.sql.ResultSet getResultSetImpl​(java.util.Map<java.lang.String,​java.lang.Class<?>> map)  
      boolean isBinary()  
      byte[] toBytes()  
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • connection

        protected BaseConnection connection
        A database connection.

      • fieldString

        protected java.lang.String fieldString
        Field value as String.

      • arrayList

        protected org.postgresql.jdbc.ArrayDecoding.PgArrayList arrayList
        Value of field as ArrayDecoding.PgArrayList. Will be initialized only once within buildArrayList(String).

      • fieldBytes

        protected byte[] fieldBytes

    • Constructor Detail

      • PgArray

        public PgArray​(BaseConnection connection,
               int oid,
               java.lang.String fieldString)
        throws java.sql.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:
        java.sql.SQLException - if something wrong happens

      • PgArray

        public PgArray​(BaseConnection connection,
               int oid,
               byte[] fieldBytes)
        throws java.sql.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:
        java.sql.SQLException - if something wrong happens

    • Method Detail

      • getArray

        public java.lang.Object getArray()
                          throws java.sql.SQLException
        Specified by:
        getArray in interface java.sql.Array
        Throws:
        java.sql.SQLException

      • getArray

        public java.lang.Object getArray​(long index,
                                 int count)
                          throws java.sql.SQLException
        Specified by:
        getArray in interface java.sql.Array
        Throws:
        java.sql.SQLException

      • getArrayImpl

        public java.lang.Object getArrayImpl​(java.util.Map<java.lang.String,​java.lang.Class<?>> map)
                              throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getArray

        public java.lang.Object getArray​(java.util.Map<java.lang.String,​java.lang.Class<?>> map)
                          throws java.sql.SQLException
        Specified by:
        getArray in interface java.sql.Array
        Throws:
        java.sql.SQLException

      • getArray

        public java.lang.Object getArray​(long index,
                                 int count,
                                 java.util.Map<java.lang.String,​java.lang.Class<?>> map)
                          throws java.sql.SQLException
        Specified by:
        getArray in interface java.sql.Array
        Throws:
        java.sql.SQLException

      • getArrayImpl

        public java.lang.Object getArrayImpl​(long index,
                                     int count,
                                     java.util.Map<java.lang.String,​java.lang.Class<?>> map)
                              throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getBaseType

        public int getBaseType()
                throws java.sql.SQLException
        Specified by:
        getBaseType in interface java.sql.Array
        Throws:
        java.sql.SQLException

      • getBaseTypeName

        public java.lang.String getBaseTypeName()
                                 throws java.sql.SQLException
        Specified by:
        getBaseTypeName in interface java.sql.Array
        Throws:
        java.sql.SQLException

      • getResultSet

        public java.sql.ResultSet getResultSet()
                                throws java.sql.SQLException
        Specified by:
        getResultSet in interface java.sql.Array
        Throws:
        java.sql.SQLException

      • getResultSet

        public java.sql.ResultSet getResultSet​(long index,
                                       int count)
                                throws java.sql.SQLException
        Specified by:
        getResultSet in interface java.sql.Array
        Throws:
        java.sql.SQLException

      • getResultSet

        public java.sql.ResultSet getResultSet​(java.util.Map<java.lang.String,​java.lang.Class<?>> map)
                                throws java.sql.SQLException
        Specified by:
        getResultSet in interface java.sql.Array
        Throws:
        java.sql.SQLException

      • getResultSet

        public java.sql.ResultSet getResultSet​(long index,
                                       int count,
                                       java.util.Map<java.lang.String,​java.lang.Class<?>> map)
                                throws java.sql.SQLException
        Specified by:
        getResultSet in interface java.sql.Array
        Throws:
        java.sql.SQLException

      • getResultSetImpl

        public java.sql.ResultSet getResultSetImpl​(java.util.Map<java.lang.String,​java.lang.Class<?>> map)
                                    throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getResultSetImpl

        public java.sql.ResultSet getResultSetImpl​(long index,
                                           int count,
                                           java.util.Map<java.lang.String,​java.lang.Class<?>> map)
                                    throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • escapeArrayElement

        public static void escapeArrayElement​(java.lang.StringBuilder b,
                                      java.lang.String s)

      • isBinary

        public boolean isBinary()

      • toBytes

        public byte[] toBytes()

      • free

        public void free()
          throws java.sql.SQLException
        Specified by:
        free in interface java.sql.Array
        Throws:
        java.sql.SQLException