- java.lang.Object
-
- com.microsoft.sqlserver.jdbc.SQLServerDataTable
-
public final class SQLServerDataTable extends Object
Represents the data table for SQL Server.
-
-
Constructor Summary
Constructors Constructor Description SQLServerDataTable()The constant in the Java programming language, sometimes referred to as a type code, that identifies the type TVP.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddColumnMetadata(SQLServerDataColumn column)Adds meta data for the specified column.voidaddColumnMetadata(String columnName, int sqlType)Adds meta data for the specified column.voidaddRow(Object... values)Adds one row of data to the data table.voidclear()Clears this data table.booleanequals(Object object)Map<Integer,SQLServerDataColumn>getColumnMetadata()Returns thejava.util.Mapobject type of columnMetaData for all columns where column indexes are mapped with their respectiveSQLServerDataColumnJava object.Iterator<Map.Entry<Integer,Object[]>>getIterator()Returns an iterator on the rows of the data table.StringgetTvpName()Returns name of TVP type set bysetTvpName(String).inthashCode()voidsetTvpName(String tvpName)Sets the TVP Name.
-
-
-
Constructor Detail
-
SQLServerDataTable
public SQLServerDataTable() throws SQLServerExceptionThe constant in the Java programming language, sometimes referred to as a type code, that identifies the type TVP.- Throws:
SQLServerException- when an error occurs
-
-
Method Detail
-
clear
public void clear()
Clears this data table.
-
getIterator
public Iterator<Map.Entry<Integer,Object[]>> getIterator()
Returns an iterator on the rows of the data table.- Returns:
- an iterator on the rows of the data table.
-
addColumnMetadata
public void addColumnMetadata(String columnName, int sqlType) throws SQLServerException
Adds meta data for the specified column.- Parameters:
columnName- the name of the columnsqlType- the sql type of the column- Throws:
SQLServerException- when an error occurs
-
addColumnMetadata
public void addColumnMetadata(SQLServerDataColumn column) throws SQLServerException
Adds meta data for the specified column.- Parameters:
column- the name of the column- Throws:
SQLServerException- when an error occurs
-
addRow
public void addRow(Object... values) throws SQLServerException
Adds one row of data to the data table.- Parameters:
values- values to be added in one row of data to the data table.- Throws:
SQLServerException- when an error occurs
-
getColumnMetadata
public Map<Integer,SQLServerDataColumn> getColumnMetadata()
Returns thejava.util.Mapobject type of columnMetaData for all columns where column indexes are mapped with their respectiveSQLServerDataColumnJava object.- Returns:
- Map
-
getTvpName
public String getTvpName()
Returns name of TVP type set bysetTvpName(String).- Returns:
- tvpName
-
setTvpName
public void setTvpName(String tvpName)
Sets the TVP Name.- Parameters:
tvpName- the name of TVP
-
-