edu.msu.nscl.olog.api

Class XmlLogbooks

java.lang.Object

edu.msu.nscl.olog.api.XmlLogbooks

public class XmlLogbooks
extends Object

Logbooks (collection) object that can be represented as XML/JSON in payload data.

Author:

Eric Berryman taken from Ralph Lange

Constructor Summary

Constructors

Constructor and Description
XmlLogbooks() Creates a new instance of XmlLogbooks.
XmlLogbooks(XmlLogbook logbook) Creates a new instance of XmlLogbooks with one initial logbook.

Method Summary

Methods

Modifier and Type	Method and Description
void	addXmlLogbook(XmlLogbook item) Adds a property to the logbook collection.
Collection<XmlLogbook>	getLogbooks() Returns a collection of XmlLogbook.
void	setLogbooks(Collection<XmlLogbook> items) Sets the collection of logbooks.
static String	toLog(XmlLogbooks data) Creates a compact string representation for the log.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlLogbooks

public XmlLogbooks()

Creates a new instance of XmlLogbooks.

XmlLogbooks

public XmlLogbooks(XmlLogbook logbook)

Creates a new instance of XmlLogbooks with one initial logbook.

Parameters:

logbook - initial element

Method Detail

getLogbooks

public Collection<XmlLogbook> getLogbooks()

Returns a collection of XmlLogbook.

Returns:

a collection of XmlLogbook

setLogbooks

public void setLogbooks(Collection<XmlLogbook> items)

Sets the collection of logbooks.

Parameters:

items - new logbook collection

addXmlLogbook

public void addXmlLogbook(XmlLogbook item)

Adds a property to the logbook collection.

Parameters:

item - the XmlLogbook to add

toLog

public static String toLog(XmlLogbooks data)

Creates a compact string representation for the log.

Parameters:

data - XmlLog to create the string representation for

Returns:

string representation