org.mozilla.mentat

Class InProgressBuilder

java.lang.Object

org.mozilla.mentat.InProgressBuilder

All Implemented Interfaces:

Closeable, AutoCloseable

public class InProgressBuilder
extends Object

This class wraps a raw pointer that points to a Rust `InProgressBuilder` object. InProgressBuilder provides a programmatic interface to performing assertions for entities. It provides functions for adding and retracting values for attributes for an entity within an in progress transaction.

The `transact` function will transact the assertions that have been added to the InProgressBuilder and pass back the TxReport that was generated by this transact and the InProgress that was used to perform the transact. This enables you to perform further transacts on the same InProgress before committing.

 long aEntid = txReport.getEntidForTempId("a");
 long bEntid = txReport.getEntidForTempId("b");
 InProgressBuilder builder = mentat.getEntityBuilder();
 builder.add(aEntid, ":foo/boolean", true);
 builder.add(bEntid, ":foo/instant", newDate);
 InProgress inProgress = builder.transact().getInProgress();
 inProgress.transact("[[:db/add \(aEntid) :foo/long 22]]");
 inProgress.commit();
 

The `commit` function will transact and commit the assertions that have been added to the InProgressBuilder. It will consume the InProgress used to perform the transact. It returns the TxReport generated by the transact. After calling `commit`, a new transaction must be started by calling

Mentat.beginTransaction()

in order to perform further actions.

 long aEntid = txReport.getEntidForTempId("a");
 long bEntid = txReport.getEntidForTempId("b");
 InProgressBuilder builder = mentat.getEntityBuilder();
 builder.add(aEntid, ":foo/boolean", true);
 builder.add(bEntid, ":foo/instant", newDate);
 builder.commit();
 

Constructor Summary

Constructors

Constructor and Description
InProgressBuilder(com.sun.jna.Pointer pointer)

Method Summary

Modifier and Type	Method and Description
void	add(long entid, String keyword, boolean value) Asserts the value of attribute `keyword` to be the provided `value`.
void	add(long entid, String keyword, Date value) Asserts the value of attribute `keyword` to be the provided `value`.
void	add(long entid, String keyword, double value) Asserts the value of attribute `keyword` to be the provided `value`.
void	add(long entid, String keyword, long value) Asserts the value of attribute `keyword` to be the provided `value`.
void	add(long entid, String keyword, String value) Asserts the value of attribute `keyword` to be the provided `value`.
void	add(long entid, String keyword, UUID value) Asserts the value of attribute `keyword` to be the provided `value`.
void	addKeyword(long entid, String keyword, String value) Asserts the value of attribute `keyword` to be the provided `value`.
void	addRef(long entid, String keyword, long value) Asserts the value of attribute `keyword` to be the provided `value`.
void	close()
TxReport	commit() Transacts the added assertions and commits.
com.sun.jna.Pointer	getPointerForUUID(UUID uuid)
UUID	getUUIDFromPointer(com.sun.jna.Pointer uuidPtr)
void	retract(long entid, String keyword, boolean value) Retracts the value of attribute `keyword` from the provided `value`.
void	retract(long entid, String keyword, Date value) Retracts the value of attribute `keyword` from the provided `value`.
void	retract(long entid, String keyword, double value) Retracts the value of attribute `keyword` from the provided `value`.
void	retract(long entid, String keyword, long value) Retracts the value of attribute `keyword` from the provided `value`.
void	retract(long entid, String keyword, String value) Retracts the value of attribute `keyword` from the provided `value`.
void	retract(long entid, String keyword, UUID value) Retracts the value of attribute `keyword` from the provided `value`.
void	retractKeyword(long entid, String keyword, String value) Retracts the value of attribute `keyword` from the provided `value`.
void	retractRef(long entid, String keyword, long value) Retracts the value of attribute `keyword` from the provided `value`.
InProgressTransactionResult	transact() Transacts the added assertions.

Methods inherited from class java.lang.Object

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

Constructor Detail

InProgressBuilder

public InProgressBuilder(com.sun.jna.Pointer pointer)

Method Detail

add

public void add(long entid,
                String keyword,
                long value)

Asserts the value of attribute `keyword` to be the provided `value`. // TODO throw exception if error occurs

Parameters:

entid - The `Entid` of the entity to be touched.

keyword - The name of the attribute in the format `:namespace/name`.

value - The value to be asserted

addRef

public void addRef(long entid,
                   String keyword,
                   long value)

Asserts the value of attribute `keyword` to be the provided `value`. // TODO throw exception if error occurs

Parameters:

entid - The `Entid` of the entity to be touched.

keyword - The name of the attribute in the format `:namespace/name`.

value - The value to be asserted

addKeyword

public void addKeyword(long entid,
                       String keyword,
                       String value)

Asserts the value of attribute `keyword` to be the provided `value`. // TODO throw exception if error occurs

Parameters:

entid - The `Entid` of the entity to be touched.

keyword - The name of the attribute in the format `:namespace/name`.

value - The value to be asserted

add

public void add(long entid,
                String keyword,
                boolean value)

Asserts the value of attribute `keyword` to be the provided `value`. // TODO throw exception if error occurs

Parameters:

entid - The `Entid` of the entity to be touched.

keyword - The name of the attribute in the format `:namespace/name`.

value - The value to be asserted

add

public void add(long entid,
                String keyword,
                double value)

Asserts the value of attribute `keyword` to be the provided `value`. // TODO throw exception if error occurs

Parameters:

entid - The `Entid` of the entity to be touched.

keyword - The name of the attribute in the format `:namespace/name`.

value - The value to be asserted

add

public void add(long entid,
                String keyword,
                Date value)

Asserts the value of attribute `keyword` to be the provided `value`. // TODO throw exception if error occurs

Parameters:

entid - The `Entid` of the entity to be touched.

keyword - The name of the attribute in the format `:namespace/name`.

value - The value to be asserted

add

public void add(long entid,
                String keyword,
                String value)

Asserts the value of attribute `keyword` to be the provided `value`. // TODO throw exception if error occurs

Parameters:

entid - The `Entid` of the entity to be touched.

keyword - The name of the attribute in the format `:namespace/name`.

value - The value to be asserted

add

public void add(long entid,
                String keyword,
                UUID value)

Asserts the value of attribute `keyword` to be the provided `value`. // TODO throw exception if error occurs

Parameters:

entid - The `Entid` of the entity to be touched.

keyword - The name of the attribute in the format `:namespace/name`.

value - The value to be asserted

retract

public void retract(long entid,
                    String keyword,
                    long value)

Retracts the value of attribute `keyword` from the provided `value`. TODO throw exception if error occurs

Parameters:

entid - The `Entid` of the entity to be touched.

keyword - The name of the attribute in the format `:namespace/name`.

value - The value to be retracted

retractRef

public void retractRef(long entid,
                       String keyword,
                       long value)

Retracts the value of attribute `keyword` from the provided `value`. TODO throw exception if error occurs

Parameters:

entid - The `Entid` of the entity to be touched.

keyword - The name of the attribute in the format `:namespace/name`.

value - The value to be retracted

retractKeyword

public void retractKeyword(long entid,
                           String keyword,
                           String value)

Retracts the value of attribute `keyword` from the provided `value`. TODO throw exception if error occurs

Parameters:

entid - The `Entid` of the entity to be touched.

keyword - The name of the attribute in the format `:namespace/name`.

value - The value to be retracted

retract

public void retract(long entid,
                    String keyword,
                    boolean value)

Retracts the value of attribute `keyword` from the provided `value`. TODO throw exception if error occurs

Parameters:

entid - The `Entid` of the entity to be touched.

keyword - The name of the attribute in the format `:namespace/name`.

value - The value to be retracted

retract

public void retract(long entid,
                    String keyword,
                    double value)

Retracts the value of attribute `keyword` from the provided `value`. TODO throw exception if error occurs

Parameters:

entid - The `Entid` of the entity to be touched.

keyword - The name of the attribute in the format `:namespace/name`.

value - The value to be retracted

retract

public void retract(long entid,
                    String keyword,
                    Date value)

Retracts the value of attribute `keyword` from the provided `value`. TODO throw exception if error occurs

Parameters:

entid - The `Entid` of the entity to be touched.

keyword - The name of the attribute in the format `:namespace/name`.

value - The value to be retracted

retract

public void retract(long entid,
                    String keyword,
                    String value)

Retracts the value of attribute `keyword` from the provided `value`. TODO throw exception if error occurs

Parameters:

entid - The `Entid` of the entity to be touched.

keyword - The name of the attribute in the format `:namespace/name`.

value - The value to be retracted

retract

public void retract(long entid,
                    String keyword,
                    UUID value)

Retracts the value of attribute `keyword` from the provided `value`. TODO throw exception if error occurs

Parameters:

entid - The `Entid` of the entity to be touched.

keyword - The name of the attribute in the format `:namespace/name`.

value - The value to be retracted

transact

public InProgressTransactionResult transact()

Transacts the added assertions. This consumes the pointer associated with this InProgressBuilder such that no further assertions can be added after the `transact` has completed. To perform further assertions, use the InProgress inside the InProgressTransactionResult returned from this function.

This does not commit the transaction. In order to do so, `commit` can be called on the InProgress inside the InProgressTransactionResult returned from this function. TODO throw exception if error occurs

Returns:

A InProgressTransactionResult containing the current InProgress and the TxReport generated by the transact.

commit

public TxReport commit()

Transacts the added assertions and commits. This consumes the pointer associated with this InProgressBuilder and the associated InProgress such that no further assertions can be added after the `commit` has completed.

To perform further assertions, a new `InProgress or InProgressBuilder should be created. TODO throw exception if error occurs

Returns:

The TxReport generated by the commit.

close

public void close()
           throws IOException

Throws:

IOException

getPointerForUUID

public com.sun.jna.Pointer getPointerForUUID(UUID uuid)

getUUIDFromPointer

public UUID getUUIDFromPointer(com.sun.jna.Pointer uuidPtr)