edu.msu.nscl.olog.api

Class XmlLog

java.lang.Object

edu.msu.nscl.olog.api.XmlLog

public class XmlLog
extends Object

Log object that can be represented as XML/JSON in payload data.

Author:

Eric Berryman taken from Ralph Lange

Constructor Summary

Constructors

Constructor and Description
XmlLog() Creates a new instance of XmlLog
XmlLog(Long logId) Creates a new instance of XmlLog.
XmlLog(Long logId, String owner) Creates a new instance of XmlLog.
XmlLog(String owner) Creates a new instance of XmlLog.

Method Summary

Methods

Modifier and Type	Method and Description
void	addXmlAttachment(XmlAttachment attachment) Adds an XmlAttachment to the collection.
void	addXmlLogbook(XmlLogbook logbook) Adds an XmlLogbook to the log.
void	addXmlProperty(XmlProperty property) Adds an XmlProperty to the log.
void	addXmlTag(XmlTag tag) Adds an XmlTag to the collection.
Date	getCreatedDate() Getter for log created date.
String	getDescription() Getter for log description.
Long	getId() Getter for log id.
String	getLevel() Getter for log level.
String	getMD5Entry() Getter for MD5 entry.
Date	getModifiedDate() Getter for log modified date.
String	getOwner() Getter for log owner.
String	getSource() Getter for log source IP.
Long	getTableId() Getter for Table id.
int	getVersion() Getter for log version id.
XmlAttachments	getXmlAttachments() Getter for the log's XmlAttachments.
Collection<XmlLogbook>	getXmlLogbooks() Getter for log's XmlLogbooks.
Collection<XmlProperty>	getXmlProperties() Getter for log's XmlProperties.
Collection<XmlTag>	getXmlTags() Getter for the log's XmlTags.
void	setCreatedDate(Date createdDate) Setter for log created date.
void	setDescription(String description) Setter for log description.
void	setId(Long logId) Setter for log id.
void	setLevel(String level) Setter for log owner.
void	setMD5Entry(String md5entry) Setter for MD5 entry.
void	setModifiedDate(Date modifiedDate) Setter for log modified date.
void	setOwner(String owner) Setter for log owner.
void	setSource(String source) Setter for log source IP.
void	setTableId(Long tableId) Setter for Table id.
void	setVersion(int version) Setter for log version id.
void	setXmlAttachments(XmlAttachments attachments) Setter for the log's XmlAttachments.
void	setXmlLogbooks(Collection<XmlLogbook> logbooks) Setter for log's XmlLogbooks.
void	setXmlProperties(Collection<XmlProperty> properties) Setter for log's XmlProperties.
void	setXmlTags(Collection<XmlTag> tags) Setter for the log's XmlTags.
static String	toLog(XmlLog 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

XmlLog

public XmlLog()

Creates a new instance of XmlLog

XmlLog

public XmlLog(Long logId)

Creates a new instance of XmlLog.

Parameters:

logId - log id

XmlLog

public XmlLog(String owner)

Creates a new instance of XmlLog.

Parameters:

subject - log subject

owner - log owner

XmlLog

public XmlLog(Long logId,
      String owner)

Creates a new instance of XmlLog.

Parameters:

logId - log id

owner - log owner

Method Detail

getId

public Long getId()

Getter for log id.

Returns:

id

setId

public void setId(Long logId)

Setter for log id.

Parameters:

logId -

getVersion

public int getVersion()

Getter for log version id.

Returns:

versionId

setVersion

public void setVersion(int version)

Setter for log version id.

Parameters:

version -

getOwner

public String getOwner()

Getter for log owner.

Returns:

owner

setOwner

public void setOwner(String owner)

Setter for log owner.

Parameters:

owner -

getLevel

public String getLevel()

Getter for log level.

Returns:

level

setLevel

public void setLevel(String level)

Setter for log owner.

Parameters:

level -

getCreatedDate

public Date getCreatedDate()

Getter for log created date.

Returns:

createdDate

setCreatedDate

public void setCreatedDate(Date createdDate)

Setter for log created date.

Parameters:

createdDate -

getModifiedDate

public Date getModifiedDate()

Getter for log modified date.

Returns:

modifiedDate

setModifiedDate

public void setModifiedDate(Date modifiedDate)

Setter for log modified date.

Parameters:

modifiedDate -

getSource

public String getSource()

Getter for log source IP.

Returns:

source IP

setSource

public void setSource(String source)

Setter for log source IP.

Parameters:

source - IP

getDescription

public String getDescription()

Getter for log description.

Returns:

description

setDescription

public void setDescription(String description)

Setter for log description.

Parameters:

description - the value to set

getMD5Entry

public String getMD5Entry()

Getter for MD5 entry.

Returns:

description

setMD5Entry

public void setMD5Entry(String md5entry)

Setter for MD5 entry.

Parameters:

description - the value to set

getTableId

public Long getTableId()

Getter for Table id.

Returns:

table id

setTableId

public void setTableId(Long tableId)

Setter for Table id.

Parameters:

Table - id to set

getXmlProperties

public Collection<XmlProperty> getXmlProperties()

Getter for log's XmlProperties.

Returns:

properties XmlProperties

setXmlProperties

public void setXmlProperties(Collection<XmlProperty> properties)

Setter for log's XmlProperties.

Parameters:

properties - XmlProperties

addXmlProperty

public void addXmlProperty(XmlProperty property)

Adds an XmlProperty to the log.

Parameters:

property - single XmlProperty

getXmlLogbooks

public Collection<XmlLogbook> getXmlLogbooks()

Getter for log's XmlLogbooks.

Returns:

XmlLogbooks

setXmlLogbooks

public void setXmlLogbooks(Collection<XmlLogbook> logbooks)

Setter for log's XmlLogbooks.

Parameters:

logbooks - XmlLogbooks

addXmlLogbook

public void addXmlLogbook(XmlLogbook logbook)

Adds an XmlLogbook to the log.

Parameters:

logbook - single XmlLogbook

getXmlTags

public Collection<XmlTag> getXmlTags()

Getter for the log's XmlTags.

Returns:

XmlTags for this log

setXmlTags

public void setXmlTags(Collection<XmlTag> tags)

Setter for the log's XmlTags.

Parameters:

tags - XmlTags

addXmlTag

public void addXmlTag(XmlTag tag)

Adds an XmlTag to the collection.

Parameters:

tag -

getXmlAttachments

public XmlAttachments getXmlAttachments()

Getter for the log's XmlAttachments.

Returns:

XmlAttachments for this log

setXmlAttachments

public void setXmlAttachments(XmlAttachments attachments)

Setter for the log's XmlAttachments.

Parameters:

attachments - XmlAttachments

addXmlAttachment

public void addXmlAttachment(XmlAttachment attachment)

Adds an XmlAttachment to the collection.

Parameters:

attachment -

toLog

public static String toLog(XmlLog data)

Creates a compact string representation for the log.

Parameters:

data - XmlLog to create the string representation for

Returns:

string representation