com.github.thomasridd.flatsy

Interface FlatsyDatabase

All Known Implementing Classes:

FlatsyFlatFileDatabase

public interface FlatsyDatabase

Created by Tom.Ridd on 15/08/15. FlatsyDatabase is document store that works, initially, from file system When your project expands Flatsy is sufficiently extensible FlatsyFlatFileDatabase: Flatsy

Method Summary

Modifier and Type	Method and Description
List<FlatsyObject>	children(FlatsyObject object) Gets a list of objects that belong to a specified parent node In filesystem terms the folder contents
void	create(FlatsyObject object, InputStream content)
void	create(FlatsyObject object, String content)
void	delete(FlatsyObject object) Delete an object from the system
FlatsyObject	get(String uri)
void	move(FlatsyObject object, String newUri) Move an object to a new uri Note that moving a folder will move all subobjects
Map<String,String>	moveMap(FlatsyObject object, String newUri) Get the mapping that would move an object and all subfiles to a new uri
FlatsyObject	parent(FlatsyObject object) Gets the parent node of the object Note that the parent of root is null
String	retrieve(FlatsyObject object) Retrieves the string contents for the FlatsyObject database object Suitable for deserialising objects from JSON
<T> Object	retrieveAs(FlatsyObject object, Class<T> tClass) Deserialise the object as a specific class
InputStream	retrieveStream(FlatsyObject object) Writes the content of the object to an OutputStream.
FlatsyObject	root()
FlatsyObjectType	type(String uri) The FlatsyObjectType of an object
void	update(FlatsyObject object, FlatsyOperator update) Update the object using a FlatsyOperator

Method Detail

root

FlatsyObject root()

get

FlatsyObject get(String uri)

create

void create(FlatsyObject object,
            String content)

create

void create(FlatsyObject object,
            InputStream content)
     throws IOException

Throws:

IOException

retrieve

String retrieve(FlatsyObject object)
         throws IOException

Retrieves the string contents for the FlatsyObject database object Suitable for deserialising objects from JSON

Parameters:

object - a FlatsyObject with valid URI

Returns:

the contents of the Flatsy object as a string

Throws:

IOException - if the object cannot be opened

retrieveStream

InputStream retrieveStream(FlatsyObject object)
                    throws IOException

Writes the content of the object to an OutputStream. This is particularly applicable to binary files

Parameters:

object - a FlatsyObject with valid URI

Returns:

an inputstream of the content

Throws:

IOException - if the object cannot be opened

retrieveAs

<T> Object retrieveAs(FlatsyObject object,
                      Class<T> tClass)

Deserialise the object as a specific class

Type Parameters:

T - generic

Parameters:

object - a Flatsy Object

tClass - the class to deserialise the object as

Returns:

The deserialised object

update

void update(FlatsyObject object,
            FlatsyOperator update)

Update the object using a FlatsyOperator

Parameters:

object - a FlatsyObject to update

update - the Operator to apply

delete

void delete(FlatsyObject object)

Delete an object from the system

Parameters:

object - the object

children

List<FlatsyObject> children(FlatsyObject object)

Gets a list of objects that belong to a specified parent node In filesystem terms the folder contents

Parameters:

object - giving the base uri

Returns:

a list of objects

parent

FlatsyObject parent(FlatsyObject object)

Gets the parent node of the object Note that the parent of root is null

Parameters:

object - an object

Returns:

its folder or equivalent

move

void move(FlatsyObject object,
          String newUri)

Move an object to a new uri Note that moving a folder will move all subobjects

Parameters:

object - a flatsy object

newUri - a new uri to move the object to

moveMap

Map<String,String> moveMap(FlatsyObject object,
                           String newUri)

Get the mapping that would move an object and all subfiles to a new uri

Parameters:

object - an object that is going to be moved

newUri - the uri it will be moved to

Returns:

A map of form moveMap.get(oldUri) = newUri

type

FlatsyObjectType type(String uri)

The FlatsyObjectType of an object

Parameters:

uri - the id of the object

Returns:

uri status