gu.sql2java

接口 BaseBean

所有已知实现类:

BaseRow, UnnameRow

public interface BaseBean

general operation definition for accessing a record from database

作者:

guyadong

方法概要

限定符和类型	方法和说明
java.util.Map<java.lang.String,java.lang.Object>	asNameValueMap()
java.util.Map<java.lang.String,java.lang.Object>	asNameValueMap(boolean ignoreNull, boolean include, java.lang.Iterable<java.lang.String> columns)
java.util.Map<java.lang.String,java.lang.Object>	asNameValueMap(boolean ignoreNull, boolean include, java.lang.String... includeColumns)
java.util.Map<java.lang.String,java.lang.Object>	asNameValueMap(boolean ignoreNull, java.lang.Iterable<java.lang.String> ignoreColumns)
java.util.Map<java.lang.String,java.lang.Object>	asNameValueMap(boolean ignoreNull, java.lang.String... ignoreColumns)
java.lang.Object[]	asValueArray(int... columnIds)
boolean	beModified() Determines if the object has been modified since the last time this method was called.
BaseBean	clone()
<B extends BaseBean> B	copy(B bean) Copies the passed bean into the current bean.
<B extends BaseBean> B	copy(B bean, int... fieldList) Copies the passed bean into the current bean.
<B extends BaseBean> B	copy(B bean, com.google.common.base.Predicate<java.lang.Integer> fieldFilter, int... fieldList) Copies the passed bean into the current bean.
<B extends BaseBean> B	copy(B bean, com.google.common.base.Predicate<java.lang.String> fieldFilter, java.lang.String... fieldList) Copies the passed bean into the current bean.
<B extends BaseBean> B	copy(B bean, java.lang.String... fieldList) Copies the passed bean into the current bean.
<B extends BaseBean,F extends BaseBean> B	copy(F from, java.util.Map<java.lang.Integer,java.lang.Integer> columnsMap) Copies the passed F bean into the current bean.
<B extends BaseBean> B	copy(java.util.Map<java.lang.Integer,java.lang.Object> values) Copies the passed values into the current bean.
boolean	equalColumn(java.lang.Object object, int... fieldList) check columns equation.
boolean	equalColumn(java.lang.Object object, int columnId) check column equation.
boolean	equalColumn(java.lang.Object object, com.google.common.base.Predicate<java.lang.Integer> fieldFilter, int... fieldList) check columns equation.
boolean	equalColumn(java.lang.Object object, com.google.common.base.Predicate<java.lang.String> fieldFilter, java.lang.String... fieldList) check columns equation.
int	getInitialized()
<T> T	getJdbcValue(int columnID)
int	getModified()
<T> T	getOriginValue(int columnID)
<T> T	getValue(int columnID)
<T> T	getValue(java.lang.String column)
<T> T	getValueChecked(int columnID)
<T> T	getValueChecked(java.lang.String column)
boolean	isInitialized(int columnID) Determines if the columnID has been initialized.
boolean	isInitialized(java.lang.String column) Determines if the column has been initialized.
boolean	isModified(int... columnIDs) Determines if the columnIDs has been modified.
boolean	isModified(int columnID) Determines if the columnID has been modified.
boolean	isModified(java.lang.String... columns) Determines if the columns has been modified.
boolean	isModified(java.lang.String column) Determines if the column has been modified.
boolean	isModifiedNested(java.lang.String nestedName) Determines if the nestedName has been modified.
boolean	isNew() Determines if the current object is new.
void	modified(int... columnIDs) set the object modification status to 'modified' and initialization status to 'initialized'
int	modifiedColumnCount()
int[]	modifiedColumnIDs()
java.lang.String[]	modifiedColumns()
<T> T	primaryValue()
java.lang.Object[]	primaryValues()
void	resetIsModified() Resets the object modification status to 'not modified'.
void	resetModified(int mask) reset columns modification status defined by mask
void	resetPrimaryKeysModified() Resets the primary keys modification status to 'not modified'.
void	setInitialized(int initialized)
void	setModified(int modified)
void	setNew(boolean isNew) Specifies to the object if it has been set as new.
<T> void	setValue(int columnID, T value) set a value representation of the given column id
void	setValue(java.lang.String column, java.lang.Object value) set a value representation of the given field
<T> boolean	setValueIf(boolean expression, int columnID, T value) set a value representation of the given column id if expression is true
boolean	setValueIf(boolean expression, java.lang.String column, java.lang.Object value) set a value representation of the given field if expression is true
<T> boolean	setValueIfNonEqual(int columnID, T value) set a value representation of the given column id if value is not equal with old
boolean	setValueIfNonEqual(java.lang.String column, java.lang.Object value) set a value representation of the given field if value is not equal with old
<T> boolean	setValueIfNonNull(int columnID, T value) set a value representation of the given column id if value is not null
boolean	setValueIfNonNull(java.lang.String column, java.lang.Object value) set a value representation of the given field if value is not null
java.lang.String	tableName()
java.lang.String	toString(boolean notNull, boolean fullIfStringOrBytes)

方法详细资料

isNew

boolean isNew()

Determines if the current object is new.

返回:

true if the current object is new, false if the object is not new

setNew

void setNew(boolean isNew)

Specifies to the object if it has been set as new.

参数:

isNew - the boolean value to be assigned to the isNew field

getInitialized

int getInitialized()

返回:

the initialized status of columns

setInitialized

void setInitialized(int initialized)

参数:

initialized - the initialized status of columns

getModified

int getModified()

返回:

the modified status of columns

setModified

void setModified(int modified)

参数:

modified - the modified status of columns

beModified

boolean beModified()

Determines if the object has been modified since the last time this method was called.
We can also determine if this object has ever been modified since its creation.

返回:

true if the object has been modified, false if the object has not been modified

modified

void modified(int... columnIDs)

set the object modification status to 'modified' and initialization status to 'initialized'

参数:

columnID -

从以下版本开始:

3.21.0

resetIsModified

void resetIsModified()

Resets the object modification status to 'not modified'.

resetModified

void resetModified(int mask)

reset columns modification status defined by mask

参数:

mask -

resetPrimaryKeysModified

void resetPrimaryKeysModified()

Resets the primary keys modification status to 'not modified'.

isInitialized

boolean isInitialized(int columnID)

Determines if the columnID has been initialized.
It is useful to determine if a field is null on purpose or just because it has not been initialized.

参数:

columnID - column id

返回:

true if the field has been initialized, false otherwise

isModified

boolean isModified(int columnID)

Determines if the columnID has been modified.

参数:

columnID - column id

返回:

true if the field has been modified, false if the field has not been modified

isModified

boolean isModified(int... columnIDs)

Determines if the columnIDs has been modified.

参数:

columnIDs - column id array

返回:

true if any field has been modified, otherwise false

从以下版本开始:

3.25.0

isModified

boolean isModified(java.lang.String... columns)

Determines if the columns has been modified.

参数:

columns - column name array

返回:

true if any field has been modified, , otherwise false

从以下版本开始:

3.25.0

isInitialized

boolean isInitialized(java.lang.String column)

Determines if the column has been initialized.
It is useful to determine if a field is null on purpose or just because it has not been initialized.

参数:

column - column name

返回:

true if the field has been initialized, false otherwise

isModified

boolean isModified(java.lang.String column)

Determines if the column has been modified.

参数:

column - column name

返回:

true if the field has been modified, false if the field has not been modified

isModifiedNested

boolean isModifiedNested(java.lang.String nestedName)

Determines if the nestedName has been modified.

参数:

nestedName - nest name start with [tablename.]column name, splitted with '.'

返回:

true if the field has been modified, false if the field has not been modified

从以下版本开始:

3.15.0

modifiedColumnIDs

int[] modifiedColumnIDs()

返回:

modified column id list or empyt array if none column be modified

从以下版本开始:

3.15.0

modifiedColumns

java.lang.String[] modifiedColumns()

返回:

modified column name list or empyt array if none column be modified

从以下版本开始:

3.15.0

modifiedColumnCount

int modifiedColumnCount()

返回:

modified column count

从以下版本开始:

3.15.0

copy

<B extends BaseBean> B copy(B bean)

Copies the passed bean into the current bean.

参数:

bean - the bean to copy into the current bean

返回:

this bean

copy

<B extends BaseBean> B copy(B bean,
                            int... fieldList)

Copies the passed bean into the current bean.

参数:

bean - the bean to copy into the current bean

fieldList - the column id list to copy into the current bean,if null or empty,copy all fields

返回:

always this bean

copy

<B extends BaseBean> B copy(B bean,
                            java.lang.String... fieldList)

Copies the passed bean into the current bean.

参数:

bean - the bean to copy into the current bean

fieldList - the column name list to copy into the current bean

返回:

always this bean

copy

<B extends BaseBean> B copy(B bean,
                            com.google.common.base.Predicate<java.lang.Integer> fieldFilter,
                            int... fieldList)

Copies the passed bean into the current bean.

参数:

bean - the bean to copy into the current bean

fieldFilter - the filter for column name,ignore if null

fieldList - the column id list to copy into the current bean

返回:

always this bean

从以下版本开始:

3.15.0

copy

<B extends BaseBean> B copy(B bean,
                            com.google.common.base.Predicate<java.lang.String> fieldFilter,
                            java.lang.String... fieldList)

Copies the passed bean into the current bean.

参数:

bean - the bean to copy into the current bean

fieldFilter - the filter for column name,ignore if null

fieldList - the column name list to copy into the current bean

返回:

always this bean

从以下版本开始:

3.14.0

copy

<B extends BaseBean,F extends BaseBean> B copy(F from,
                                               java.util.Map<java.lang.Integer,java.lang.Integer> columnsMap)

Copies the passed F bean into the current bean.

类型参数:

B - from bean type

F - this bean type

参数:

from -

columnsMap - columns map from F to B

返回:

always this bean

copy

<B extends BaseBean> B copy(java.util.Map<java.lang.Integer,java.lang.Object> values)

Copies the passed values into the current bean.

参数:

values -

返回:

always this bean

equalColumn

boolean equalColumn(java.lang.Object object,
                    com.google.common.base.Predicate<java.lang.String> fieldFilter,
                    java.lang.String... fieldList)

check columns equation.

参数:

object - the bean to compare

fieldFilter - the filter for column name,ignore if null

fieldList - the column name list to compare to the current bean

返回:

true if special columns is all equal to object,otherwise false

从以下版本开始:

3.15.0

equalColumn

boolean equalColumn(java.lang.Object object,
                    com.google.common.base.Predicate<java.lang.Integer> fieldFilter,
                    int... fieldList)

check columns equation.

参数:

object - the bean to compare

fieldFilter - the filter for column name,ignore if null

fieldList - the column id list to compare to the current bean

返回:

true if special columns is all equal to object,otherwise false

从以下版本开始:

3.15.0

equalColumn

boolean equalColumn(java.lang.Object object,
                    int... fieldList)

check columns equation.

参数:

object - the bean to compare

fieldList - the column id list to compare to the current bean

返回:

true if special columns is all equal to object,otherwise false

从以下版本开始:

3.15.0

equalColumn

boolean equalColumn(java.lang.Object object,
                    int columnId)

check column equation.

参数:

object - the bean to compare

fieldList - the column id to compare to the current bean

返回:

true if special column is equal to object,otherwise false

从以下版本开始:

3.15.0

getValue

<T> T getValue(int columnID)

参数:

columnID - column id

返回:

return a object representation of the given column id

getOriginValue

<T> T getOriginValue(int columnID)

参数:

columnID - column id

返回:

return a origin object representation of the given column id

从以下版本开始:

3.18.0

getJdbcValue

<T> T getJdbcValue(int columnID)

参数:

columnID -

返回:

return a value as JDBC store type representation of the given column id

从以下版本开始:

3.22.0

setValue

<T> void setValue(int columnID,
                  T value)

set a value representation of the given column id

参数:

columnID - column id

value -

setValueIfNonNull

<T> boolean setValueIfNonNull(int columnID,
                              T value)

set a value representation of the given column id if value is not null

参数:

columnID - column id

value -

返回:

true if not null,otherwise false

从以下版本开始:

3.14.0

setValueIfNonEqual

<T> boolean setValueIfNonEqual(int columnID,
                               T value)

set a value representation of the given column id if value is not equal with old

参数:

columnID - column id

value -

返回:

true if not equal,otherwise false

从以下版本开始:

3.14.0

setValueIf

<T> boolean setValueIf(boolean expression,
                       int columnID,
                       T value)

set a value representation of the given column id if expression is true

参数:

columnID - column id

value -

返回:

expression always

从以下版本开始:

3.14.0

getValue

<T> T getValue(java.lang.String column)

参数:

column - column name

返回:

return a object representation of the given field

getValueChecked

<T> T getValueChecked(int columnID)

参数:

columnID - column id

返回:

return a object representation of the given column id or throw NullPointerException if value is null

getValueChecked

<T> T getValueChecked(java.lang.String column)

参数:

column - column name

返回:

return a object representation of the given field or throw NullPointerException if value is null

setValue

void setValue(java.lang.String column,
              java.lang.Object value)

set a value representation of the given field

参数:

column - column name

value -

setValueIfNonNull

boolean setValueIfNonNull(java.lang.String column,
                          java.lang.Object value)

set a value representation of the given field if value is not null

参数:

column - column name

value -

返回:

true if not null,otherwise false

从以下版本开始:

3.14.0

setValueIfNonEqual

boolean setValueIfNonEqual(java.lang.String column,
                           java.lang.Object value)

set a value representation of the given field if value is not equal with old

参数:

column - column name

value -

返回:

true if not equal,otherwise false

从以下版本开始:

3.14.0

setValueIf

boolean setValueIf(boolean expression,
                   java.lang.String column,
                   java.lang.Object value)

set a value representation of the given field if expression is true

参数:

column - column name

value -

返回:

expression always

从以下版本开始:

3.14.0

asValueArray

java.lang.Object[] asValueArray(int... columnIds)

参数:

columnIds - column id that will be output, if null or empty,output all columns

返回:

values array for all fields

asNameValueMap

java.util.Map<java.lang.String,java.lang.Object> asNameValueMap()

返回:

view of values map for all fields, column name -- value

asNameValueMap

java.util.Map<java.lang.String,java.lang.Object> asNameValueMap(boolean ignoreNull,
                                                                java.lang.String... ignoreColumns)

参数:

ignoreNull - remove all null column

ignoreColumns - remove column name list

返回:

values map for all fields, column name -- value

asNameValueMap

java.util.Map<java.lang.String,java.lang.Object> asNameValueMap(boolean ignoreNull,
                                                                java.lang.Iterable<java.lang.String> ignoreColumns)

参数:

ignoreNull - remove all null column

ignoreColumns - remove column name list

返回:

values map for all fields, column name -- value

asNameValueMap

java.util.Map<java.lang.String,java.lang.Object> asNameValueMap(boolean ignoreNull,
                                                                boolean include,
                                                                java.lang.Iterable<java.lang.String> columns)

参数:

ignoreNull - remove all null column

include - if true,the columns is white list(include) for column, only output columns which in list,otherwise it's black list(exclude)

columns - column name list for white/black(include/exclude) list

返回:

values map for all fields, column name -- value

asNameValueMap

java.util.Map<java.lang.String,java.lang.Object> asNameValueMap(boolean ignoreNull,
                                                                boolean include,
                                                                java.lang.String... includeColumns)

参数:

ignoreNull - remove all null column

include - if true,the columns is white list(include) for column, only output columns which in list,otherwise it's black list(exclude)

columns - remove column name list

返回:

values map for all fields, column name -- value

primaryValues

java.lang.Object[] primaryValues()

返回:

values array for all primary key, empty array if no primary key

primaryValue

<T> T primaryValue()

类型参数:

T - PK type

返回:

value for primary key, throw UnsupportedOperationException if there is more than one primary key

tableName

java.lang.String tableName()

返回:

table name of this bean

toString

java.lang.String toString(boolean notNull,
                          boolean fullIfStringOrBytes)

参数:

notNull - output not null field only if true

fullIfStringOrBytes - for string or bytes field,output full content if true,otherwise output length.

返回:

Returns a string representation of the object

clone

BaseBean clone()