net.cnri.repository.util

Class RepositoryJSONSerializer

java.lang.Object

net.cnri.repository.util.RepositoryJSONSerializer

public class RepositoryJSONSerializer
extends java.lang.Object

Provides methods for serializing an arbitrary DigitalDbject to a JSON string and back again. You can either serialize a DigitalObject a list of DigitalObjects or an entire repository. Also provides a method for directly loading a repositroy from a url that returns a JSON string.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RepositoryJSONSerializer.DOView The DOView object loads all attributes and elements of a digital object into into a java object.

Constructor Summary

Constructors

Constructor and Description
RepositoryJSONSerializer()

Method Summary

Methods

Modifier and Type	Method and Description
static MemoryDigitalObject	createDigitalObjectFromJson(java.lang.String json)
static java.util.List<MemoryDigitalObject>	createDigitalObjectsFromDOViews(java.util.List<RepositoryJSONSerializer.DOView> doViews)
static java.util.List<MemoryDigitalObject>	createDigitalObjectsFromJson(java.lang.String json)
static java.util.List<RepositoryJSONSerializer.DOView>	fromJSON(java.lang.String json)
static java.util.List<RepositoryJSONSerializer.DOView>	getDOViewsFromURL(java.lang.String url)
static java.lang.String	getJSONFromURL(java.lang.String url)
static boolean	loadDOViewIntoRepository(RepositoryJSONSerializer.DOView view, Repository repository)
static void	loadDOViewsIntoRepository(java.util.List<RepositoryJSONSerializer.DOView> views, Repository repository)
static boolean	loadJsonIntoDigitalObject(java.lang.String json, DigitalObject dobj)
static void	loadRepositoryFromURL(Repository repository, java.lang.String url) Loads a Repository from a URL given that the URL returns a correctly formatted JSON string.
static java.util.List<RepositoryJSONSerializer.DOView>	readJsonStream(java.io.InputStream in)
static java.util.List<RepositoryJSONSerializer.DOView>	toDOViews(java.util.List<DigitalObject> objects)
static java.util.List<RepositoryJSONSerializer.DOView>	toDOViews(java.util.List<DigitalObject> objects, java.util.List<java.lang.String> elementsToInclude)
static java.lang.String	toJSON(DigitalObject dobj) Given a single DigitalObject this method will return a JSON String that represents that object.
static java.lang.String	toJSON(DigitalObject dobj, java.util.List<java.lang.String> elementsToInclude) Given a Repository this method will return a JSON String that the object in the Repository.
static java.lang.String	toJSON(java.util.List<DigitalObject> objects) Given a list of DigitalObjects this method will return a JSON String that represents those objects.
static java.lang.String	toJSON(java.util.List<DigitalObject> objects, java.util.List<java.lang.String> elementsToInclude) Given a list of DigitalObjects this method will return a JSON String that represents those objects.
static java.lang.String	toJSON(Repository repository) Given a Repository this method will return a JSON String that represents all the object in the Repository.
static java.lang.String	toJSON(Repository repository, java.util.List<java.lang.String> elementsToInclude) Given a Repository this method will return a JSON String that represents all the object in the Repository.
static void	writeJSONStream(java.io.OutputStream out, java.util.List<DigitalObject> objects)

Methods inherited from class java.lang.Object

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

Constructor Detail

RepositoryJSONSerializer

public RepositoryJSONSerializer()

Method Detail

loadRepositoryFromURL

public static void loadRepositoryFromURL(Repository repository,
                         java.lang.String url)
                                  throws java.io.IOException,
                                         RepositoryException,
                                         CreationException

Loads a Repository from a URL given that the URL returns a correctly formatted JSON string.

Parameters:

repository - The Repositroy you want to load the objects into.

url - The URL that will return the JSON

Throws:

ClientProtocolException

java.io.IOException

RepositoryException

CreationException

getDOViewsFromURL

public static java.util.List<RepositoryJSONSerializer.DOView> getDOViewsFromURL(java.lang.String url)
                                                                         throws java.io.IOException

Throws:

java.io.IOException

getJSONFromURL

public static java.lang.String getJSONFromURL(java.lang.String url)
                                       throws java.io.IOException

Throws:

java.io.IOException

loadDOViewsIntoRepository

public static void loadDOViewsIntoRepository(java.util.List<RepositoryJSONSerializer.DOView> views,
                             Repository repository)
                                      throws RepositoryException,
                                             CreationException

Throws:

RepositoryException

CreationException

createDigitalObjectFromJson

public static MemoryDigitalObject createDigitalObjectFromJson(java.lang.String json)
                                                       throws RepositoryException

Throws:

RepositoryException

createDigitalObjectsFromJson

public static java.util.List<MemoryDigitalObject> createDigitalObjectsFromJson(java.lang.String json)
                                                                        throws RepositoryException

Throws:

RepositoryException

createDigitalObjectsFromDOViews

public static java.util.List<MemoryDigitalObject> createDigitalObjectsFromDOViews(java.util.List<RepositoryJSONSerializer.DOView> doViews)
                                                                           throws RepositoryException

Throws:

RepositoryException

loadJsonIntoDigitalObject

public static boolean loadJsonIntoDigitalObject(java.lang.String json,
                                DigitalObject dobj)
                                         throws RepositoryException

Throws:

RepositoryException

loadDOViewIntoRepository

public static boolean loadDOViewIntoRepository(RepositoryJSONSerializer.DOView view,
                               Repository repository)
                                        throws RepositoryException,
                                               CreationException

Throws:

RepositoryException

CreationException

toJSON

public static java.lang.String toJSON(Repository repository)

Given a Repository this method will return a JSON String that represents all the object in the Repository.

Parameters:

repository -

toJSON

public static java.lang.String toJSON(Repository repository,
                      java.util.List<java.lang.String> elementsToInclude)

Given a Repository this method will return a JSON String that represents all the object in the Repository. Only elements explicitly included in the in elementsToInclude List will be included in the JSON

Parameters:

repository -

elementsToInclude - A list of Strings that are the names of the elements to be included in the JSON

toJSON

public static java.lang.String toJSON(DigitalObject dobj)

Given a single DigitalObject this method will return a JSON String that represents that object.

toJSON

public static java.lang.String toJSON(DigitalObject dobj,
                      java.util.List<java.lang.String> elementsToInclude)

Given a Repository this method will return a JSON String that the object in the Repository. Only elements explicitly included in the in elementsToInclude List will be included in the JSON

Parameters:

elementsToInclude - A list of Strings that are the names of the elements to be included in the JSON

writeJSONStream

public static void writeJSONStream(java.io.OutputStream out,
                   java.util.List<DigitalObject> objects)
                            throws java.io.IOException

Throws:

java.io.IOException

readJsonStream

public static java.util.List<RepositoryJSONSerializer.DOView> readJsonStream(java.io.InputStream in)
                                                                      throws java.io.IOException

Throws:

java.io.IOException

toDOViews

public static java.util.List<RepositoryJSONSerializer.DOView> toDOViews(java.util.List<DigitalObject> objects)

toDOViews

public static java.util.List<RepositoryJSONSerializer.DOView> toDOViews(java.util.List<DigitalObject> objects,
                                                        java.util.List<java.lang.String> elementsToInclude)

toJSON

public static java.lang.String toJSON(java.util.List<DigitalObject> objects)

Given a list of DigitalObjects this method will return a JSON String that represents those objects.

toJSON

public static java.lang.String toJSON(java.util.List<DigitalObject> objects,
                      java.util.List<java.lang.String> elementsToInclude)

Given a list of DigitalObjects this method will return a JSON String that represents those objects. Only elements explicitly included in the in elementsToInclude List will be included in the JSON

Parameters:

elementsToInclude - A list of Strings that are the names of the elements to be included in the JSON

fromJSON

public static java.util.List<RepositoryJSONSerializer.DOView> fromJSON(java.lang.String json)