gu.sql2java.BaseBean Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sql2java-base Show documentation
Show all versions of sql2java-base Show documentation
sql2java common class package
package gu.sql2java;
import java.util.Map;
import com.google.common.base.Function;
import com.google.common.base.Predicate;
/**
* general operation definition for accessing a record from database
* @author guyadong
*
*/
public interface BaseBean{
/**
* Determines if the current object is new.
*
* @return true if the current object is new, false if the object is not new
*/
public boolean isNew();
/**
* Specifies to the object if it has been set as new.
*
* @param isNew the boolean value to be assigned to the isNew field
*/
public void setNew(boolean isNew);
/**
* @return the initialized status of columns
*/
public String getInitialized();
/**
* @param initialized the initialized status of columns
*/
public void setInitialized(String initialized);
/**
* @return the modified status of columns
*/
public String getModified();
/**
* @param modified the modified status of columns
*/
public void setModified(String modified);
/**
* 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.
*
* @return true if the object has been modified, false if the object has not been modified
*/
public boolean beModified();
/**
* set the object modification status to 'modified' and initialization status to 'initialized'
* @param columnID column id
* @since 4.3.0
*/
public void modified(int columnID);
/**
* set the object modification status to 'modified' and initialization status to 'initialized'
* @param columnIDs column id array,ignore if {@code null}
* @since 3.21.0
*/
public void modified(int[] columnIDs);
/**
* set the object modification status to 'modified' and initialization status to 'initialized'
* @param columnID column id
* @param columnIDs column id array,ignore if {@code null}
* @since 4.3.0
*/
public void modified(int columnID,int ...columnIDs);
/**
* set the object modification status to 'modified' and initialization status to 'initialized'
* @param column column name
* @since 4.3.0
*/
public void modified(String column);
/**
* set the object modification status to 'modified' and initialization status to 'initialized'
* @param columns column name array,ignore if {@code null}
* @since 4.3.0
*/
public void modified(String[] columns);
/**
* set the object modification status to 'modified' and initialization status to 'initialized'
* @param column column name
* @param columns column name array,ignore if {@code null}
* @since 4.3.0
*/
public void modified(String column,String... columns);
/**
* Resets the object modification status to 'not modified'.
*/
public void resetModified();
/**
* reset columns modification status defined by {@code columnID}
* @param columnID column id
*/
public void resetModified(int columnID);
/**
* reset columns modification status defined by {@code columnIDs}
* @param columnIDs column id array,ignore if {@code null}
* @since 3.32.0
*/
public void resetModified(int[] columnIDs) ;
/**
* reset columns modification status defined by {@code columnID},{@code columnIDs}
* @param columnID column id
* @param columnIDs column id array,ignore if {@code null}
* @since 3.32.0
*/
public void resetModified(int columnID, int... columnIDs);
/**
* reset columns modification status defined by {@code column}
* @param column column name
* @since 3.32.0
*/
public void resetModified(String column);
/**
* reset columns modification status defined by {@code column},{@code columns}
* @param column column name
* @param columns column name array,ignore if {@code null}
* @since 3.32.0
*/
public void resetModified(String column, String... columns);
/**
* reset columns modification status defined by {@code columns}
* @param columns column name array,ignore if {@code null}
* @since 3.32.0
*/
public void resetModified(String[] columns);
/**
* Read record (old record) from the database based on the primary key,
* compare all modified fields in the current bean with the corresponding fields of the old record,
* and if equal (deep equals),
* reset the bit corresponding of the {@code modified} field
* Note: This method can only be used on (local) server side
* @since 4.3.2
*/
public void resetModifiedIfEqual();
/**
* Resets the primary keys modification status to 'not modified'.
*/
public void resetPrimaryKeysModified();
/**
* Resets columns modification status except primary keys to 'not modified'.
* @since 4.3.0
*/
public void resetModifiedExceptPrimaryKeys();
/**
* Determines if the {@code columnID} has been initialized.
* It is useful to determine if a field is null on purpose or just because it has not been initialized.
* @param columnID column id
* @return true if the field has been initialized, false otherwise
*/
public boolean isInitialized(int columnID);
/**
* Determines if the {@code columnID} has been modified.
* @param columnID column id
* @return true if the field has been modified, false if the field has not been modified
*/
public boolean isModified(int columnID);
/**
* Determines if the {@code columnIDs} has been modified.
* @param columnIDs column id array
* @return true if any field has been modified, otherwise false
* @since 3.25.0
*/
public boolean isModified(int... columnIDs);
/**
* Determines if the {@code columns} has been modified.
* @param columns column name array
* @return true if any field has been modified, , otherwise false
* @since 3.25.0
*/
public boolean isModified(String... columns);
/**
* Determines if the {@code column} has been initialized.
* It is useful to determine if a field is null on purpose or just because it has not been initialized.
* @param column column name
* @return true if the field has been initialized, false otherwise
*/
public boolean isInitialized(String column);
/**
* Determines if the {@code column} has been modified.
* @param column column name
* @return true if the field has been modified, false if the field has not been modified
*/
public boolean isModified(String column);
/**
* Determines if the {@code nestedName} has been modified.
* @param nestedName nest name start with [tablename.]column name, splitted with '.'
* @return true if the field has been modified, false if the field has not been modified
* @since 3.15.0
*/
public boolean isModifiedNested(String nestedName);
/**
* @return modified column id list or empyt array if none column be modified
* @since 3.15.0
*/
public int[] modifiedColumnIDs();
/**
* @return modified column name list or empyt array if none column be modified
* @since 3.15.0
*/
public String[] modifiedColumns();
/**
* @return modified column count
* @since 3.15.0
*/
public int modifiedColumnCount();
/**
* Copies the passed bean into the current bean.
*
* @param bean the bean to copy into the current bean
* @return this bean
*/
public B copy(B bean);
/**
* Copies the passed bean into the current bean.
*
* @param bean the bean to copy into the current bean
* @param fieldList the column id list to copy into the current bean,if null or empty,copy all fields
* @return always this bean
*/
public B copy(B bean, int... fieldList);
/**
* Copies the passed bean into the current bean.
*
* @param bean the bean to copy into the current bean
* @param fieldList the column name list to copy into the current bean
* @return always this bean
*/
public B copy(B bean, String... fieldList);
/**
* Copies the passed bean into the current bean.
*
* @param bean the bean to copy into the current bean
* @param fieldFilter the filter for column name,ignore if null
* @param fieldList the column id list to copy into the current bean
* @return always this bean
* @since 3.15.0
*/
public B copy(B bean, Predicate fieldFilter, int... fieldList);
/**
* Copies the passed bean into the current bean.
*
* @param bean the bean to copy into the current bean
* @param fieldFilter the filter for column name,ignore if null
* @param fieldList the column name list to copy into the current bean
* @return always this bean
* @since 3.14.0
*/
public B copy(B bean, Predicate fieldFilter, String... fieldList);
/**
* Read record (old record) from the database based on the primary key,
* copy all fields of the current object that are be modified and different from the old record,
* and return the updated old record.
* Note: This method can only be used on (local) server side
* @param
* @return If {@link #isNew()} is true or the current object is not a BaseRow instance,
* return the current object
* @since 4.3.2
*/
public B copyIfNonEqual();
/**
* Copies the passed F bean into the current bean.
* @param from bean type
* @param this bean type
* @param from
* @param columnsMap columns map from F to B
* @return always this bean
*/
B copy(F from, Map columnsMap);
/**
* Copies the passed values with key-value map into the current bean.
* Integer or String type required for key,otherwise ignore
* @param values
* @return always this bean
*/
@SuppressWarnings("rawtypes")
public B copy(Map values);
/**
* Copies the passed values with key-value map into the current bean.
* Integer or String type required for key,otherwise ignore
* The copied columns were filtered by the beanfilter deserialization filter,
* and static JSON invisible columns were also filtered
* @param
* @param values
* @param keyTransformer function for transform key in map to column id or name,ignore if null
* @param ignoreUnmap ignore the value if return null column column(id or name) by keyTransformer
* @return always this bean
* @since 3.29.3
*/
@SuppressWarnings("rawtypes")
public B copy(Map values, Function keyTransformer, boolean ignoreUnmap);
/**
* Copies the passed values into the current bean.
* @param values
* @return always this bean
* @since 4.0.0
*/
public B copyJson(Mapvalues);
/**
* check columns equation.
*
* @param object the bean to compare
* @param fieldFilter the filter for column name,ignore if null
* @param fieldList the column name list to compare to the current bean
* @return {@code true} if special columns is all equal to object,otherwise false
* @since 3.15.0
*/
public boolean equalColumn(Object object, Predicate fieldFilter, String... fieldList);
/**
* check columns equation.
*
* @param object the bean to compare
* @param fieldFilter the filter for column name,ignore if null
* @param fieldList the column id list to compare to the current bean
* @return {@code true} if special columns is all equal to object,otherwise false
* @since 3.15.0
*/
public boolean equalColumn(Object object, Predicate fieldFilter, int... fieldList);
/**
* check columns equation.
*
* @param object the bean to compare
* @param fieldList the column id list to compare to the current bean
* @return {@code true} if special columns is all equal to object,otherwise false
* @since 3.15.0
*/
public boolean equalColumn(Object object, int... fieldList);
/**
* check column equation.
* @param object the bean to compare
* @param columnId column id
* @return {@code true} if special column is equal to object,otherwise false
* @since 3.15.0
*/
public boolean equalColumn(Object object, int columnId);
/**
*
* @param columnID column id
* @return return a object representation of the given column id
*/
public T getValue(int columnID);
/**
*
* @param columnID column id
* @return return a origin object representation of the given column id
* @since 3.18.0
*/
public T getOriginValue(int columnID);
/**
* @param columnID
* @return return a value as JDBC store type representation of the given column id
* @since 3.22.0
*/
public T getJdbcValue(int columnID);
/**
* set a value representation of the given column id
* @param columnID column id
* @param value
*/
public void setValue(int columnID,T value);
/**
* set a value representation of the given column id if value is not null
* @param columnID column id
* @param value
* @return true if not null,otherwise false
* @since 3.14.0
*/
public boolean setValueIfNonNull(int columnID,T value);
/**
* set a value representation of the given column id if value is not equal with old
* @param columnID column id
* @param value
* @return true if not equal,otherwise false
* @since 3.14.0
*/
public boolean setValueIfNonEqual(int columnID, T value);
/**
* set a value representation of the given column id if expression is true
* @param columnID column id
* @param value
* @return expression always
* @since 3.14.0
*/
public boolean setValueIf(boolean expression, int columnID, T value);
/**
*
* @param column column name
* @return return a object representation of the given field
*/
public T getValue(String column);
/**
*
* @param columnID column id
* @return return a object representation of the given column id or throw {@link NullPointerException} if value is null
*/
public T getValueChecked(int columnID);
/**
*
* @param column column name
* @return return a object representation of the given field or throw {@link NullPointerException} if value is null
*/
public T getValueChecked(String column);
/**
* set a value representation of the given field
* @param column column name
* @param value
*/
public void setValue(String column,Object value);
/**
* set a value representation of the given field if value is not null
* @param column column name
* @param value
* @return true if not null,otherwise false
* @since 3.14.0
*/
public boolean setValueIfNonNull(String column, Object value);
/**
* set a value representation of the given field if value is not equal with old
* @param column column name
* @param value
* @return true if not equal,otherwise false
* @since 3.14.0
*/
public boolean setValueIfNonEqual(String column, Object value);
/**
* set a value representation of the given field if expression is true
* @param column column name
* @param value
* @return expression always
* @since 3.14.0
*/
public boolean setValueIf(boolean expression, String column, Object value);
/**
* Test integral fields with bits specified by the mask
* @param columnID column id
* @param mask integral type required(Long|Integer|Short|Byte)
* @param bitOr
* @return {@code column&mask != 0} if bitOr is true otherwise {@code column&mask == mask}
* @since 3.27.0
*/
public boolean testBitValue(int columnID, Number mask, boolean bitOr);
/**
* Test integral fields with bits specified by the mask
* @param column column name
* @param mask integral type required(Long|Integer|Short|Byte)
* @return {@code column&mask != 0} if bitOr is true otherwise {@code column&mask == mask}
* @since 3.27.0
*/
public boolean testBitValue(String column, Number mask, boolean bitOr);
/**
* @param columnID column id
* @param mask integral type required(Long|Integer|Short|Byte)
* @return Returns not null integral value of the bit specified by the mask mask of the integral field specified by columnID
* @since 3.27.0
*/
T getBitValue(int columnID, Number mask);
/**
* @param column column name
* @param mask integral type required(Long|Integer|Short|Byte)
* @return Returns not null integral value of the bit specified by the mask mask of the integral field
* @since 3.27.0
*/
T getBitValue(String column, Number mask);
/**
* Set the mask value of the integral field specified by columnID and the value of the bit specified by the mask
* @param columnID column id
* @param mask integral type required(Long|Integer|Short|Byte)
* @param bitSet set bit to 1 if true,otherwise set bit to 0
* @since 3.27.0
*/
void setBitValue(int columnID, Number mask, boolean bitSet);
/**
* Set the mask value of the integral field specified by column and the value of the bit specified by the mask
* @param column column name
* @param mask integral type required(Long|Integer|Short|Byte)
* @param bitSet set bit to 1 if true,otherwise set bit to 0
* @since 3.27.0
*/
void setBitValue(String column, Number mask, boolean bitSet);
/**
* Set the mask value of the integral field specified by column and the value of the bit specified by the mask if mask and old value is not null
* @param column column name
* @param mask integral type required(Long|Integer|Short|Byte)
* @param bitSet set bit to 1 if true,otherwise set bit to 0
* @since 3.27.0
*/
boolean setBitValueIfNonNull(String column, Number mask, boolean bitSet);
/**
* Set the mask value of the integral field specified by column and the value of the bit specified by the mask if expression is true
* @param column column name
* @param mask integral type required(Long|Integer|Short|Byte)
* @param bitSet set bit to 1 if true,otherwise set bit to 0
* @since 3.27.0
*/
boolean setBitValueIf(boolean expression, String column, Number mask, boolean bitSet);
/**
* @param columnIds column id that will be output, if null or empty,output all columns
* @return values array for all fields
*/
public Object[] asValueArray(int...columnIds);
/**
* view of values map for all fields, column name -- value
*/
public Map asNameValueMap();
/**
* Return the column name -- value mapping that filtered by beanfilter
* @since 3.32.5
*/
public Map asFilterableNameValueMap();
/**
* @param ignoreNull remove all null column
* @param ignoreColumns remove column name list
* @return values map for all fields, column name -- value
*/
public Map asNameValueMap(boolean ignoreNull,String ...ignoreColumns);
/**
* @param ignoreNull remove all null column
* @param ignoreColumns remove column name list
* @return values map for all fields, column name -- value
*/
public Map asNameValueMap(boolean ignoreNull,IterableignoreColumns);
/**
* @param ignoreNull remove all null column
* @param include if {@code true},the {@code columns} is white list(include) for column, only output columns which in list,otherwise it's black list(exclude)
* @param columns column name list for white/black(include/exclude) list
* @return values map for all fields, column name -- value
*/
Map asNameValueMap(boolean ignoreNull, final boolean include, Iterablecolumns);
/**
* @param ignoreNull remove all null column
* @param include if {@code true},the {@code columns} is white list(include) for column, only output columns which in list,otherwise it's black list(exclude)
* @param includeColumns remove column name list
* @return values map for all fields, column name -- value
*/
Map asNameValueMap(boolean ignoreNull, boolean include, String ...includeColumns);
/**
* @param ignoreNull remove all null column
* @param serialize serialize field if exist annotation JSONField and specialize serialized class
* @param include if {@code true},the {@code columns} is white list(include) for column, only output columns which in list,otherwise it's black list(exclude)
* @param columns column name list for white/black(include/exclude) list
* @return values map for all fields, column name -- value
* @since 3.27.0
*/
Map asNameValueMap(boolean ignoreNull,boolean serialize, final boolean include, Iterablecolumns);
/**
* @param ignoreNull remove all null column
* @param serialize serialize field if exist annotation JSONField and specialize serialized class
* @param include if {@code true},the {@code columns} is white list(include) for column, only output columns which in list,otherwise it's black list(exclude)
* @param includeColumns remove column name list
* @return values map for all fields, column name -- value
* @since 3.27.0
*/
Map asNameValueMap(boolean ignoreNull, boolean serialize,boolean include, String ...includeColumns);
/**
* @return values array for all primary key, empty array if no primary key
*/
public Object[] primaryValues();
/**
* @param PK type
* @return value for primary key, throw {@link UnsupportedOperationException} if there is more than one primary key
*/
public T primaryValue();
/**
* @return table name of this bean
*/
public String tableName();
/**
* @param notNull output not null field only if {@code true}
* @param fullIfStringOrBytes for string or bytes field,output full content if {@code true},otherwise output length.
* @return Returns a string representation of the object
*/
public String toString(boolean notNull, boolean fullIfStringOrBytes);
public BaseBean clone();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy