com.googlecode.fascinator.common

Class Manifest

java.lang.Object

com.googlecode.fascinator.common.JsonSimple

com.googlecode.fascinator.common.Manifest

public class Manifest
extends JsonSimple

Represents a JSON manifest as used in other parts of the application. Provides methods to simplify common manipulations of the manifest.

Author:

Greg Pendlebury

Constructor Summary

Constructors

Constructor and Description
Manifest(java.io.InputStream jsonIn) Creates Manifest object from the provided input stream
Manifest(JsonObject newJsonObject) Wrap a JsonObject in this class
Manifest(java.lang.String jsonString) Creates Manifest object from the provided string

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addTopNode(java.lang.String id, java.lang.String title) Add a new child node to the top level.
boolean	delete(java.lang.String id)
java.lang.String	getDescription() Get the description for this manifest
ManifestNode	getNode(java.lang.String key) Get the requested node from the manifest.
java.lang.String	getTitle() Get the title for this manifest
java.util.List<ManifestNode>	getTopNodes() Get the requested node from the manifest.
java.lang.String	getType() Get the type of this manifest
java.lang.String	getViewId() Get the 'viewId' node for this manifest
boolean	move(java.lang.String id, java.lang.String destination)
boolean	moveAfter(java.lang.String id, java.lang.String destination)
boolean	moveBefore(java.lang.String id, java.lang.String destination)
void	setDescription(java.lang.String description) Set the description for this manifest
void	setTitle(java.lang.String title) Set the title for this manifest
void	setType(java.lang.String type) Set the type of this manifest
void	setViewId(java.lang.String viewId) Set the 'viewId' node for this manifest
int	size() Return the total number of nodes in this manifest.

Methods inherited from class com.googlecode.fascinator.common.JsonSimple

fromJavaMap, getArray, getBoolean, getInteger, getJsonArray, getJsonObject, getJsonSimpleList, getJsonSimpleMap, getObject, getPath, getString, getStringList, getStringList, getStringList, search, setPropertySubstitution, toJavaList, toJavaMap, toString, toString, writeArray, writeObject

Methods inherited from class java.lang.Object

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

Constructor Detail

Manifest

public Manifest(JsonObject newJsonObject)

Wrap a JsonObject in this class

Parameters:

newJsonObject - : The JsonObject to wrap

Manifest

public Manifest(java.io.InputStream jsonIn)
         throws java.io.IOException

Creates Manifest object from the provided input stream

Parameters:

jsonIn - : The input stream to read

Throws:

java.io.IOException - if there was an error during creation

Manifest

public Manifest(java.lang.String jsonString)
         throws java.io.IOException

Creates Manifest object from the provided string

Parameters:

jsonString - : The JSON in string form

Throws:

java.io.IOException - if there was an error during creation

Method Detail

size

public int size()

Return the total number of nodes in this manifest.

Returns:

int : The number of nodes.

getNode

public ManifestNode getNode(java.lang.String key)

Get the requested node from the manifest.

Parameters:

id - : The node key to retrieve

Returns:

ManifestNode : The retrieved node, null if not found

addTopNode

public boolean addTopNode(java.lang.String id,
                 java.lang.String title)

Add a new child node to the top level.

Parameters:

id - : The ID value to put in this node.

title - : The title value to put in this node.

Returns:

boolean : True if successful, otherwise False

getTopNodes

public java.util.List<ManifestNode> getTopNodes()

Get the requested node from the manifest.

Parameters:

id - : The node key to retrieve

Returns:

ManifestNode : The retrieved node, null if not found

move

public boolean move(java.lang.String id,
           java.lang.String destination)

moveAfter

public boolean moveAfter(java.lang.String id,
                java.lang.String destination)

moveBefore

public boolean moveBefore(java.lang.String id,
                 java.lang.String destination)

delete

public boolean delete(java.lang.String id)

getDescription

public java.lang.String getDescription()

Get the description for this manifest

Returns:

String : The description of this manifest

setDescription

public void setDescription(java.lang.String description)

Set the description for this manifest

Parameters:

description - : The new description

getTitle

public java.lang.String getTitle()

Get the title for this manifest

Returns:

String : The title of this manifest

setTitle

public void setTitle(java.lang.String title)

Set the title for this manifest

Parameters:

title - : The new title

getType

public java.lang.String getType()

Get the type of this manifest

Returns:

String : The type of this manifest

setType

public void setType(java.lang.String type)

Set the type of this manifest

Parameters:

type - : The new type

getViewId

public java.lang.String getViewId()

Get the 'viewId' node for this manifest

Returns:

String : The viewId of this manifest

setViewId

public void setViewId(java.lang.String viewId)

Set the 'viewId' node for this manifest

Parameters:

viewId - : The new viewId