com.sequoiadb.base.options

Class InsertOption

java.lang.Object

com.sequoiadb.base.options.InsertOption

All Implemented Interfaces:

Cloneable

public class InsertOption
extends Object

The optional parameter of the insert operation.

Since:

3.4.5/5.0.3

Field Summary

Fields

Modifier and Type	Field and Description
static int	FLG_INSERT_CONTONDUP The flag represent whether insert continue(no errors were reported) when hitting index key duplicate error
static int	FLG_INSERT_CONTONDUP_ID The flag represent the error of the dup key will be ignored when the dup key is '_id'.
static int	FLG_INSERT_REPLACEONDUP The flag represent whether insert becomes update when hitting index key duplicate error.
static int	FLG_INSERT_REPLACEONDUP_ID The flag represents the error of the dup key will be ignored when the dup key is '_id', and the original record will be replaced by new record.
static int	FLG_INSERT_RETURN_OID The flag represent whether insert return the "_id" field of the record for user

Constructor Summary

Constructors

Constructor and Description
InsertOption()

Method Summary

Modifier and Type	Method and Description
void	appendFlag(int flag) Appends a new flag to the insert option.
Object	clone()
void	eraseFlag(int flag) Erases the specified flag from the insert option.
int	getFlag() Gets the flag option.
InsertOption	setFlag(int flag) Sets the flag option.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

FLG_INSERT_CONTONDUP

public static final int FLG_INSERT_CONTONDUP

The flag represent whether insert continue(no errors were reported) when hitting index key duplicate error

See Also:

Constant Field Values

FLG_INSERT_CONTONDUP_ID

public static final int FLG_INSERT_CONTONDUP_ID

The flag represent the error of the dup key will be ignored when the dup key is '_id'.

See Also:

Constant Field Values

FLG_INSERT_REPLACEONDUP

public static final int FLG_INSERT_REPLACEONDUP

The flag represent whether insert becomes update when hitting index key duplicate error.

See Also:

Constant Field Values

FLG_INSERT_REPLACEONDUP_ID

public static final int FLG_INSERT_REPLACEONDUP_ID

The flag represents the error of the dup key will be ignored when the dup key is '_id', and the original record will be replaced by new record.

See Also:

Constant Field Values

FLG_INSERT_RETURN_OID

public static final int FLG_INSERT_RETURN_OID

The flag represent whether insert return the "_id" field of the record for user

See Also:

Constant Field Values

Constructor Detail

InsertOption

public InsertOption()

Method Detail

appendFlag

public void appendFlag(int flag)

Appends a new flag to the insert option.

Parameters:

flag - The insert flag, the following values:

• FLG_INSERT_CONTONDUP
• FLG_INSERT_RETURN_OID
• FLG_INSERT_REPLACEONDUP
• FLG_INSERT_CONTONDUP_ID
• FLG_INSERT_REPLACEONDUP_ID

clone

public Object clone()
             throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

eraseFlag

public void eraseFlag(int flag)

Erases the specified flag from the insert option.

Parameters:

flag - The insert flag, the following values:

• FLG_INSERT_CONTONDUP
• FLG_INSERT_RETURN_OID
• FLG_INSERT_REPLACEONDUP
• FLG_INSERT_CONTONDUP_ID
• FLG_INSERT_REPLACEONDUP_ID

getFlag

public int getFlag()

Gets the flag option.

Returns:

The value of flag option.

setFlag

public InsertOption setFlag(int flag)

Sets the flag option.

Parameters:

flag - The insert flag, default to be 0, the following values:

• FLG_INSERT_CONTONDUP
• FLG_INSERT_RETURN_OID
• FLG_INSERT_REPLACEONDUP
• FLG_INSERT_CONTONDUP_ID
• FLG_INSERT_REPLACEONDUP_ID

Returns:

this

toString

public String toString()

Overrides:

toString in class Object