gov.bnl.channelfinder.api

Class XmlChannel

java.lang.Object

gov.bnl.channelfinder.api.XmlChannel

public class XmlChannel
extends Object

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

Author:

Kunal Shroff <shroffk@bnl.gov>, Ralph Lange <ralph.lange@gmx.de>

Constructor Summary

Constructors

Constructor and Description
XmlChannel() Creates a new instance of XmlChannel
XmlChannel(String name) Creates a new instance of XmlChannel.
XmlChannel(String name, String owner) Creates a new instance of XmlChannel.
XmlChannel(String name, String owner, List<XmlProperty> properties, List<XmlTag> tags)

Method Summary

Modifier and Type	Method and Description
void	addXmlProperty(XmlProperty property) Adds an XmlProperty to the channel.
void	addXmlTag(XmlTag tag) Adds an XmlTag to the collection.
String	getName() Getter for channel name.
String	getOwner() Getter for channel owner.
List<XmlProperty>	getProperties()
List<XmlTag>	getTags()
void	setName(String name) Setter for channel name.
void	setOwner(String owner) Setter for channel owner.
void	setProperties(List<XmlProperty> properties)
void	setTags(List<XmlTag> tags)
static String	toLog(XmlChannel 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

XmlChannel

public XmlChannel()

Creates a new instance of XmlChannel

XmlChannel

public XmlChannel(String name)

Creates a new instance of XmlChannel.

Parameters:

name - channel name

XmlChannel

public XmlChannel(String name,
                  String owner)

Creates a new instance of XmlChannel.

Parameters:

name - channel name

owner - owner name

XmlChannel

public XmlChannel(String name,
                  String owner,
                  List<XmlProperty> properties,
                  List<XmlTag> tags)

Parameters:

name - - channel name

owner - - channel owner

properties - - list of channel properties

tags - - list of channel tags

Method Detail

getName

public String getName()

Getter for channel name.

Returns:

name - channel name

setName

public void setName(String name)

Setter for channel name.

Parameters:

name - the value to set

getOwner

public String getOwner()

Getter for channel owner.

Returns:

owner

setOwner

public void setOwner(String owner)

Setter for channel owner.

Parameters:

owner - - channel owner

getProperties

public List<XmlProperty> getProperties()

setProperties

public void setProperties(List<XmlProperty> properties)

addXmlProperty

public void addXmlProperty(XmlProperty property)

Adds an XmlProperty to the channel.

Parameters:

property - single XmlProperty

getTags

public List<XmlTag> getTags()

setTags

public void setTags(List<XmlTag> tags)

addXmlTag

public void addXmlTag(XmlTag tag)

Adds an XmlTag to the collection.

Parameters:

tag - - tag to be added to channel

toLog

public static String toLog(XmlChannel data)

Creates a compact string representation for the log.

Parameters:

data - XmlChannel to create the string representation for

Returns:

string representation