com.cybozu.kintone.database

Class ResultSet

java.lang.Object

com.cybozu.kintone.database.ResultSet

public class ResultSet
extends java.lang.Object

Resultset class Represents a kintone database result set. The data set is read only.

Constructor Summary

Constructors

Constructor and Description
ResultSet(Connection connection)

Method Summary

Modifier and Type	Method and Description
void	add(Record record) Adds a new record.
void	clear() Clears the result set.
java.io.File	downloadFile(java.lang.String name, int index) Downloads the file body.
boolean	first() Moves to the first record.
java.util.Date	getDate(java.lang.String name) Gets the field value as date.
java.util.Date	getDateTime(java.lang.String name) Gets the field value as date time.
java.util.Set<java.util.Map.Entry<java.lang.String,Field>>	getEntrySet() Gets the entry set of the record.
java.util.Set<java.lang.String>	getFieldNames() Gets the set of the field name.
FieldType	getFieldType(java.lang.String name) Gets the field type of the specified field.
java.util.List<FileDto>	getFiles(java.lang.String name) Gets the field value as file object.
java.lang.Long	getId() Gets the record number of the record.
java.lang.Long	getLong(java.lang.String name) Gets the field value as long.
java.lang.Long	getRevision() Gets the revision number of the record.
java.lang.String	getString(java.lang.String name) Gets the field value as string.
java.util.List<java.lang.String>	getStrings(java.lang.String name) Gets the field value as string array.
java.util.List<Record>	getSubtable(java.lang.String name) Gets the field value as a sub table.
java.lang.Long	getTotalCount() Gets total count.
UserDto	getUser(java.lang.String name) Gets the field value as user object.
java.util.List<UserDto>	getUsers(java.lang.String name) Gets the field value as user object array.
boolean	hasField(java.lang.String name) Checks if the record has the field.
boolean	isEmpty(java.lang.String name) Checks if the record value is empty.
boolean	last() Moves to the last record.
boolean	next() Moves to the next record.
boolean	previous() Moves to the previous record.
void	setTotalCount(long totalCount) Sets total count
int	size() Gets the count of the record set.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ResultSet

public ResultSet(Connection connection)

Parameters:

connection - The database connection which retrieved this result set.

Method Detail

add

public void add(Record record)

Adds a new record.

Parameters:

record - record object

clear

public void clear()

Clears the result set.

previous

public boolean previous()

Moves to the previous record.

Returns:

true if succeeded

next

public boolean next()

Moves to the next record.

Returns:

true if succeeded

first

public boolean first()

Moves to the first record.

Returns:

true if succeeded

last

public boolean last()

Moves to the last record.

Returns:

true if succeeded

getId

public java.lang.Long getId()

Gets the record number of the record.

Returns:

record number

getRevision

public java.lang.Long getRevision()

Gets the revision number of the record.

Returns:

revision number

size

public int size()

Gets the count of the record set.

Returns:

record count

hasField

public boolean hasField(java.lang.String name)

Checks if the record has the field.

Parameters:

name - field name

Returns:

true if the field exists

isEmpty

public boolean isEmpty(java.lang.String name)

Checks if the record value is empty.

Parameters:

name - field name

Returns:

true if the field value is empty

getTotalCount

public java.lang.Long getTotalCount()

Gets total count.

Returns:

total count

setTotalCount

public void setTotalCount(long totalCount)

Sets total count

Parameters:

totalCount - total count

getLong

public java.lang.Long getLong(java.lang.String name)

Gets the field value as long.

Parameters:

name - field name

Returns:

a long value of the field

getString

public java.lang.String getString(java.lang.String name)

Gets the field value as string.

Parameters:

name - field name

Returns:

a string value of the field

getUser

public UserDto getUser(java.lang.String name)

Gets the field value as user object.

Parameters:

name - field name

Returns:

a user object

getUsers

public java.util.List<UserDto> getUsers(java.lang.String name)

Gets the field value as user object array.

Parameters:

name - field name

Returns:

a list of user objects

getFiles

public java.util.List<FileDto> getFiles(java.lang.String name)

Gets the field value as file object.

Parameters:

name - field name

Returns:

a list of file objects

getStrings

public java.util.List<java.lang.String> getStrings(java.lang.String name)

Gets the field value as string array.

Parameters:

name - field name

Returns:

a list of strings

getDate

public java.util.Date getDate(java.lang.String name)

Gets the field value as date.

Parameters:

name - field name

Returns:

a date object

getDateTime

public java.util.Date getDateTime(java.lang.String name)

Gets the field value as date time.

Parameters:

name - field name

Returns:

a date object

getSubtable

public java.util.List<Record> getSubtable(java.lang.String name)

Gets the field value as a sub table.

Parameters:

name -

Returns:

a sub table object

getFieldType

public FieldType getFieldType(java.lang.String name)

Gets the field type of the specified field.

Parameters:

name - field name

Returns:

field type

getFieldNames

public java.util.Set<java.lang.String> getFieldNames()

Gets the set of the field name.

Returns:

set of the field name

getEntrySet

public java.util.Set<java.util.Map.Entry<java.lang.String,Field>> getEntrySet()

Gets the entry set of the record.

Returns:

the entry set of the record

downloadFile

public java.io.File downloadFile(java.lang.String name,
                                 int index)
                          throws java.io.IOException,
                                 DBException

Downloads the file body.

Parameters:

name - field name

index - index of the download file

Returns:

downloaded file

Throws:

java.io.IOException

DBException