org.seasar.doma.jdbc.criteria.context

Class InsertSettings

java.lang.Object

org.seasar.doma.jdbc.criteria.context.Settings

org.seasar.doma.jdbc.criteria.context.InsertSettings

public class InsertSettings
extends Settings

Represents the settings for an INSERT criteria query.

Constructor Summary

Constructors

Constructor and Description
InsertSettings()

Method Summary

Modifier and Type	Method and Description
java.util.List<PropertyMetamodel<?>>	exclude() Returns the excluded properties.
void	exclude(PropertyMetamodel<?>... propertyMetamodels) Sets the excluded properties.
int	getBatchSize() Returns the batch size.
boolean	getExcludeNull() Returns whether to exclude null properties or not.
boolean	getIgnoreGeneratedKeys() Returns whether auto-generated keys are ignored.
java.util.List<PropertyMetamodel<?>>	include() Returns the included properties.
void	include(PropertyMetamodel<?>... propertyMetamodels) Sets the included properties.
void	setBatchSize(int batchSize) Sets the batch size.
void	setExcludeNull(boolean excludeNull) Sets whether to exclude null properties or not.
void	setIgnoreGeneratedKeys(boolean ignoreGeneratedKeys) If this flag is enabled, performance may be improved.

Methods inherited from class org.seasar.doma.jdbc.criteria.context.Settings

getComment, getQueryTimeout, getSqlLogType, setComment, setQueryTimeout, setSqlLogType

Methods inherited from class java.lang.Object

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

Constructor Detail

InsertSettings

public InsertSettings()

Method Detail

getBatchSize

public int getBatchSize()

Returns the batch size.

Returns:

the batch size. The default value is 0.

setBatchSize

public void setBatchSize(int batchSize)

Sets the batch size.

If the value is less than 1, it is regarded as 1.

Parameters:

batchSize - the batch size

See Also:

Statement.executeBatch(), PreparedStatement.addBatch()

getExcludeNull

public boolean getExcludeNull()

Returns whether to exclude null properties or not.

Returns:

whether to exclude null properties or not. The default value is false.

setExcludeNull

public void setExcludeNull(boolean excludeNull)

Sets whether to exclude null properties or not.

If the value is true, the null properties are excluded from the SQL INSERT statement.

Parameters:

excludeNull - whether to exclude null properties or not

include

public java.util.List<PropertyMetamodel<?>> include()

Returns the included properties.

Returns:

the included properties

include

public void include(PropertyMetamodel<?>... propertyMetamodels)

Sets the included properties.

Parameters:

propertyMetamodels - the included properties

exclude

public java.util.List<PropertyMetamodel<?>> exclude()

Returns the excluded properties.

Returns:

the excluded properties

exclude

public void exclude(PropertyMetamodel<?>... propertyMetamodels)

Sets the excluded properties.

Parameters:

propertyMetamodels - the excluded properties

getIgnoreGeneratedKeys

public boolean getIgnoreGeneratedKeys()

Returns whether auto-generated keys are ignored.

Returns:

Whether auto-generated keys are ignored.

setIgnoreGeneratedKeys

public void setIgnoreGeneratedKeys(boolean ignoreGeneratedKeys)

If this flag is enabled, performance may be improved. However, note that entities won't have auto-generated keys.

Parameters:

ignoreGeneratedKeys - whether auto-generated keys are ignored