com.github.thomasridd.flatsy

Class FlatsyFlatFileDatabase

java.lang.Object

com.github.thomasridd.flatsy.FlatsyFlatFileDatabase

All Implemented Interfaces:

FlatsyDatabase

public class FlatsyFlatFileDatabase
extends Object
implements FlatsyDatabase

Created by Tom.Ridd on 15/08/15.

Constructor Summary

Constructors

Constructor and Description
FlatsyFlatFileDatabase(Path root)

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) Update an object uri and all child objects
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()
String	toString()
FlatsyObjectType	type(String uri) The FlatsyObjectType of an object
void	update(FlatsyObject object, FlatsyOperator update) Update the object using a FlatsyOperator

Methods inherited from class java.lang.Object

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

Constructor Detail

FlatsyFlatFileDatabase

public FlatsyFlatFileDatabase(Path root)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

root

public FlatsyObject root()

Specified by:

root in interface FlatsyDatabase

get

public FlatsyObject get(String uri)

Specified by:

get in interface FlatsyDatabase

create

public void create(FlatsyObject object,
                   String content)

Specified by:

create in interface FlatsyDatabase

create

public void create(FlatsyObject object,
                   InputStream content)
            throws IOException

Specified by:

create in interface FlatsyDatabase

Throws:

IOException

retrieve

public String retrieve(FlatsyObject object)

Description copied from interface: FlatsyDatabase

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

Specified by:

retrieve in interface FlatsyDatabase

Parameters:

object - a FlatsyObject with valid URI

Returns:

the contents of the Flatsy object as a string

retrieveStream

public InputStream retrieveStream(FlatsyObject object)
                           throws IOException

Description copied from interface: FlatsyDatabase

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

Specified by:

retrieveStream in interface FlatsyDatabase

Parameters:

object - a FlatsyObject with valid URI

Returns:

an inputstream of the content

Throws:

IOException - if the object cannot be opened

retrieveAs

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

Description copied from interface: FlatsyDatabase

Deserialise the object as a specific class

Specified by:

retrieveAs in interface FlatsyDatabase

Type Parameters:

T - generic

Parameters:

object - a Flatsy Object

tClass - the class to deserialise the object as

Returns:

The deserialised object

update

public void update(FlatsyObject object,
                   FlatsyOperator update)

Description copied from interface: FlatsyDatabase

Update the object using a FlatsyOperator

Specified by:

update in interface FlatsyDatabase

Parameters:

object - a FlatsyObject to update

update - the Operator to apply

delete

public void delete(FlatsyObject object)

Description copied from interface: FlatsyDatabase

Delete an object from the system

Specified by:

delete in interface FlatsyDatabase

Parameters:

object - the object

children

public List<FlatsyObject> children(FlatsyObject object)

Description copied from interface: FlatsyDatabase

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

Specified by:

children in interface FlatsyDatabase

Parameters:

object - giving the base uri

Returns:

a list of objects

parent

public FlatsyObject parent(FlatsyObject object)

Description copied from interface: FlatsyDatabase

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

Specified by:

parent in interface FlatsyDatabase

Parameters:

object - an object

Returns:

its folder or equivalent

move

public void move(FlatsyObject object,
                 String newUri)

Update an object uri and all child objects

Specified by:

move in interface FlatsyDatabase

Parameters:

object - an object to move

newUri - a new uri to move it to

moveMap

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

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

Specified by:

moveMap in interface FlatsyDatabase

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

public FlatsyObjectType type(String uri)

Description copied from interface: FlatsyDatabase

The FlatsyObjectType of an object

Specified by:

type in interface FlatsyDatabase

Parameters:

uri - the id of the object

Returns:

uri status