com.pcube.apps.engage.policy
Class ProtocolFamily

java.lang.Object
  com.pcube.apps.engage.foundations.NamedObjectBase
      com.pcube.apps.engage.policy.ProtocolFamily

All Implemented Interfaces:

Formattable, com.pcube.apps.framework.commons.Filter, com.pcube.apps.framework.commons.NamedObject

public class ProtocolFamily
extends com.pcube.apps.engage.foundations.NamedObjectBase
implements Formattable, com.pcube.apps.framework.commons.Filter

A category of protocols. A Protocol Family is a group of protocols sharing common properties, like the P2P protocol family. Grouping protocols into famlies is used in the reporter to create famliy oriented reports, e.g P2P or VOIP usage reports.

Author:

rafis

Field Summary

static java.lang.String	XML_ATT_ID
static java.lang.String	XML_ATT_NAME
static java.lang.String	XML_TAG_NAME
static java.lang.String	XML_TAG_REF_PROTOCOL
static java.lang.String	XML_TAG_REF_SIGNATURE

Constructor Summary

ProtocolFamily()

Method Summary

boolean	accept(java.lang.Object p) return true if the specified protocol is a member of this family
void	addProtocol(Protocol p)
void	addProtocol(java.lang.String name)
void	addSignature(Signature s)
void	addSignature(java.lang.String name)
com.pcube.apps.framework.commons.Filter	chain(com.pcube.apps.framework.commons.Filter f)
boolean	equals(java.lang.Object o)
void	fromStream(java.io.BufferedReader in, Formatter f) Method fromStream
ProtocolFamily	fromXML(org.w3c.dom.Element familyElement) parse family from XML element
int	getId()
java.util.List	getProtocolNames()
java.util.List	getSignatureNames()
boolean	isHidden()
void	setHidden(boolean hidden)
void	setId(int id)
void	toStream(java.io.PrintStream out, Formatter f) Method toStream
java.lang.String	toString()
org.w3c.dom.Element	toXML(org.w3c.dom.Document doc) convert to DOM element

Methods inherited from class com.pcube.apps.engage.foundations.NamedObjectBase

addPropertyChangedListener, addVetoableChangeListener, getName, removePropertyChangedListener, removeVetoableChangeListener, setName

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

XML_TAG_NAME

public static final java.lang.String XML_TAG_NAME

See Also:

Constant Field Values

XML_ATT_NAME

public static final java.lang.String XML_ATT_NAME

See Also:

Constant Field Values

XML_ATT_ID

public static final java.lang.String XML_ATT_ID

See Also:

Constant Field Values

XML_TAG_REF_PROTOCOL

public static final java.lang.String XML_TAG_REF_PROTOCOL

See Also:

Constant Field Values

XML_TAG_REF_SIGNATURE

public static final java.lang.String XML_TAG_REF_SIGNATURE

See Also:

Constant Field Values

Constructor Detail

ProtocolFamily

public ProtocolFamily()

Method Detail

fromStream

public void fromStream(java.io.BufferedReader in,
                       Formatter f)
                throws ImportExportException

Description copied from interface: Formattable

Method fromStream

Specified by:

fromStream in interface Formattable

Throws:

ImportExportException

See Also:

Formattable.fromStream(java.io.BufferedReader, com.pcube.apps.engage.common.Formatter)

toStream

public void toStream(java.io.PrintStream out,
                     Formatter f)

Description copied from interface: Formattable

Method toStream

Specified by:

toStream in interface Formattable

See Also:

Formattable.toStream(java.io.PrintStream, com.pcube.apps.engage.common.Formatter)

isHidden

public boolean isHidden()

getId

public int getId()

Returns:

Returns the id.

setId

public void setId(int id)

Parameters:

id - The id to set.

getSignatureNames

public java.util.List getSignatureNames()

getProtocolNames

public java.util.List getProtocolNames()

addProtocol

public void addProtocol(Protocol p)

addProtocol

public void addProtocol(java.lang.String name)

addSignature

public void addSignature(Signature s)

addSignature

public void addSignature(java.lang.String name)

fromXML

public ProtocolFamily fromXML(org.w3c.dom.Element familyElement)
                       throws ImportExportException

parse family from XML element

Parameters:

familyElement -

Returns:

Throws:

ImportExportException

setHidden

public void setHidden(boolean hidden)

toXML

public org.w3c.dom.Element toXML(org.w3c.dom.Document doc)

convert to DOM element

Parameters:

doc -

Returns:

accept

public boolean accept(java.lang.Object p)

return true if the specified protocol is a member of this family

Specified by:

accept in interface com.pcube.apps.framework.commons.Filter

See Also:

com.pcube.apps.engage.policy.ProtocolFilter#accept(com.pcube.apps.engage.policy.Protocol)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

chain

public com.pcube.apps.framework.commons.Filter chain(com.pcube.apps.framework.commons.Filter f)

Specified by:

chain in interface com.pcube.apps.framework.commons.Filter

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object