Package xtdb.api

Class XtdbDocument

java.lang.Object

xtdb.api.XtdbDocument

public final class XtdbDocument
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XtdbDocument.Builder

Method Summary

Modifier and Type	Method	Description
static XtdbDocument	build(Object id, Consumer<XtdbDocument.Builder> f)
static XtdbDocument.Builder	builder(Object id)
static XtdbDocument	create(Object id)	Creates a new XtdbDocument with just an ID key.
static XtdbDocument	create(Object id, Map<String,Object> data)
static XtdbDocument	createFunction(Object id, String rawFunction)	Static factory to create an XTDB transaction function document.
boolean	equals(Object o)
static XtdbDocument	factory(clojure.lang.IPersistentMap input)	Creates an XtdbDocument from a Clojure map.
Object	get(String key)
Object	getId()
int	hashCode()
XtdbDocument	minus(String key)
XtdbDocument	minusAll(Iterable<String> keys)
XtdbDocument	plus(String key, Object value)
XtdbDocument	plusAll(Map<String,Object> entries)
clojure.lang.IPersistentMap	toMap()	Not intended for public use, may be removed.

Methods inherited from class java.lang.Object

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

Method Details

build

public static XtdbDocument build(Object id,
 Consumer<XtdbDocument.Builder> f)

builder

public static XtdbDocument.Builder builder(Object id)

factory

public static XtdbDocument factory(clojure.lang.IPersistentMap input)

Creates an XtdbDocument from a Clojure map. Not intended for public use, may be removed.

Parameters:

input -

create

public static XtdbDocument create(Object id)

Creates a new XtdbDocument with just an ID key. See XtdbDocument for valid ID types

Parameters:

id -

Returns:

a new XtdbDocument

createFunction

public static XtdbDocument createFunction(Object id,
 String rawFunction)

Static factory to create an XTDB transaction function document.

Parameters:

id - the id of the transaction function

rawFunction - the function body, as a Clojure-code string.

Returns:

the function document, suitable for use in Transaction.Builder.put(XtdbDocument)

create

public static XtdbDocument create(Object id,
 Map<String,Object> data)

plus

public XtdbDocument plus(String key,
 Object value)

Returns:

a new XtdbDocument with the key/value added

plusAll

public XtdbDocument plusAll(Map<String,Object> entries)

Returns:

a new XtdbDocument with the entries added

minus

public XtdbDocument minus(String key)

Returns:

a new XtdbDocument with the key removed

minusAll

public XtdbDocument minusAll(Iterable<String> keys)

Returns:

a new XtdbDocument with the keys removed

get

public Object get(String key)

getId

public Object getId()

toMap

public clojure.lang.IPersistentMap toMap()

Not intended for public use, may be removed.

Returns:

this document as a Clojure map.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object