jadex.bridge.fipa

Class DFComponentDescription

java.lang.Object

jadex.bridge.fipa.DFComponentDescription

All Implemented Interfaces:

IDFComponentDescription, java.io.Serializable, java.lang.Cloneable

public class DFComponentDescription
extends java.lang.Object
implements IDFComponentDescription, java.io.Serializable, java.lang.Cloneable

An component description.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List	languages Attribute for slot languages.
protected java.util.Date	leasetime Attribute for slot lease-time.
protected IComponentIdentifier	name Attribute for slot componentidentifier.
protected java.util.List	ontologies Attribute for slot ontologies.
protected java.util.List	protocols Attribute for slot protocols.
protected java.util.List	services Attribute for slot services.

Constructor Summary

Constructors

Constructor and Description
DFComponentDescription() Create a new component description.
DFComponentDescription(IComponentIdentifier name) Create a new component description.
DFComponentDescription(IComponentIdentifier name, IDFServiceDescription service) Convenience constructor for searching/registering.
DFComponentDescription(IComponentIdentifier name, IDFServiceDescription[] services, java.lang.String[] protocols, java.lang.String[] ontologies, java.lang.String[] languages, java.util.Date leasetime) Create a new component description.
DFComponentDescription(IComponentIdentifier name, IDFServiceDescription service, java.util.Date leasetime) Convenience constructor for searching/registering.

Method Summary

Modifier and Type	Method and Description
void	addLanguage(java.lang.String language) Add a language to this ComponentDescription.
void	addOntology(java.lang.String ontology) Add a ontology to this ComponentDescription.
void	addProtocol(java.lang.String protocol) Add a protocol to this ComponentDescription.
void	addService(IDFServiceDescription service) Add a service to this ComponentDescription.
java.lang.Object	clone() Clone a component description.
boolean	equals(java.lang.Object obj)
java.lang.String	getLanguage(int idx) Get an languages of this ComponentDescription.
java.lang.String[]	getLanguages() Get the languages of this ComponentDescription.
java.util.Date	getLeaseTime() Get the lease-time of this ComponentDescription.
IComponentIdentifier	getName() Get the componentidentifier of this ComponentDescription.
java.lang.String[]	getOntologies() Get the ontologies of this ComponentDescription.
java.lang.String	getOntology(int idx) Get an ontologies of this ComponentDescription.
java.lang.String	getProtocol(int idx) Get an protocols of this ComponentDescription.
java.lang.String[]	getProtocols() Get the protocols of this ComponentDescription.
IDFServiceDescription	getService(int idx) Get an services of this ComponentDescription.
IDFServiceDescription[]	getServices() Get the services of this ComponentDescription.
int	hashCode()
boolean	removeLanguage(java.lang.String language) Remove a language from this ComponentDescription.
boolean	removeOntology(java.lang.String ontology) Remove a ontology from this ComponentDescription.
boolean	removeProtocol(java.lang.String protocol) Remove a protocol from this ComponentDescription.
boolean	removeService(IDFServiceDescription service) Remove a service from this ComponentDescription.
void	setLanguage(int idx, java.lang.String language) Set a language to this ComponentDescription.
void	setLanguages(java.lang.String[] languages) Set the languages of this ComponentDescription.
void	setLeaseTime(java.util.Date leasetime) Set the lease-time of this ComponentDescription.
void	setName(IComponentIdentifier name) Set the componentidentifier of this ComponentDescription.
void	setOntologies(java.lang.String[] ontologies) Set the ontologies of this ComponentDescription.
void	setOntology(int idx, java.lang.String ontology) Set a ontology to this ComponentDescription.
void	setProtocol(int idx, java.lang.String protocol) Set a protocol to this ComponentDescription.
void	setProtocols(java.lang.String[] protocols) Set the protocols of this ComponentDescription.
void	setService(int idx, IDFServiceDescription service) Set a service to this ComponentDescription.
void	setServices(IDFServiceDescription[] services) Set the services of this ComponentDescription.
java.lang.String	toString() Get a string representation of this ComponentDescription.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

languages

protected java.util.List languages

Attribute for slot languages.

name

protected IComponentIdentifier name

Attribute for slot componentidentifier.

ontologies

protected java.util.List ontologies

Attribute for slot ontologies.

services

protected java.util.List services

Attribute for slot services.

leasetime

protected java.util.Date leasetime

Attribute for slot lease-time.

protocols

protected java.util.List protocols

Attribute for slot protocols.

Constructor Detail

DFComponentDescription

public DFComponentDescription()

Create a new component description.

DFComponentDescription

public DFComponentDescription(IComponentIdentifier name)

Create a new component description.

Parameters:

name - The name.

DFComponentDescription

public DFComponentDescription(IComponentIdentifier name,
                              IDFServiceDescription[] services,
                              java.lang.String[] protocols,
                              java.lang.String[] ontologies,
                              java.lang.String[] languages,
                              java.util.Date leasetime)

Create a new component description.

Parameters:

name - The name.

services - The services.

protocols - The protocols.

ontologies - The ontologies.

languages - The languages.

DFComponentDescription

public DFComponentDescription(IComponentIdentifier name,
                              IDFServiceDescription service)

Convenience constructor for searching/registering.

DFComponentDescription

public DFComponentDescription(IComponentIdentifier name,
                              IDFServiceDescription service,
                              java.util.Date leasetime)

Convenience constructor for searching/registering.

Method Detail

getLanguages

public java.lang.String[] getLanguages()

Get the languages of this ComponentDescription.

Specified by:

getLanguages in interface IDFComponentDescription

Returns:

languages

setLanguages

public void setLanguages(java.lang.String[] languages)

Set the languages of this ComponentDescription.

Parameters:

languages - the value to be set

getLanguage

public java.lang.String getLanguage(int idx)

Get an languages of this ComponentDescription.

Parameters:

idx - The index.

Returns:

languages

setLanguage

public void setLanguage(int idx,
                        java.lang.String language)

Set a language to this ComponentDescription.

Parameters:

idx - The index.

language - a value to be added

addLanguage

public void addLanguage(java.lang.String language)

Add a language to this ComponentDescription.

Parameters:

language - a value to be removed

removeLanguage

public boolean removeLanguage(java.lang.String language)

Remove a language from this ComponentDescription.

Parameters:

language - a value to be removed

Returns:

True when the languages have changed.

getName

public IComponentIdentifier getName()

Get the componentidentifier of this ComponentDescription.

Specified by:

getName in interface IDFComponentDescription

Returns:

componentidentifier

setName

public void setName(IComponentIdentifier name)

Set the componentidentifier of this ComponentDescription.

Parameters:

name - the value to be set

getOntologies

public java.lang.String[] getOntologies()

Get the ontologies of this ComponentDescription.

Specified by:

getOntologies in interface IDFComponentDescription

Returns:

ontologies

setOntologies

public void setOntologies(java.lang.String[] ontologies)

Set the ontologies of this ComponentDescription.

Parameters:

ontologies - the value to be set

getOntology

public java.lang.String getOntology(int idx)

Get an ontologies of this ComponentDescription.

Parameters:

idx - The index.

Returns:

ontologies

setOntology

public void setOntology(int idx,
                        java.lang.String ontology)

Set a ontology to this ComponentDescription.

Parameters:

idx - The index.

ontology - a value to be added

addOntology

public void addOntology(java.lang.String ontology)

Add a ontology to this ComponentDescription.

Parameters:

ontology - a value to be removed

removeOntology

public boolean removeOntology(java.lang.String ontology)

Remove a ontology from this ComponentDescription.

Parameters:

ontology - a value to be removed

Returns:

True when the ontologies have changed.

getServices

public IDFServiceDescription[] getServices()

Get the services of this ComponentDescription.

Specified by:

getServices in interface IDFComponentDescription

Returns:

services

setServices

public void setServices(IDFServiceDescription[] services)

Set the services of this ComponentDescription.

Parameters:

services - the value to be set

getService

public IDFServiceDescription getService(int idx)

Get an services of this ComponentDescription.

Parameters:

idx - The index.

Returns:

services

setService

public void setService(int idx,
                       IDFServiceDescription service)

Set a service to this ComponentDescription.

Parameters:

idx - The index.

service - a value to be added

addService

public void addService(IDFServiceDescription service)

Add a service to this ComponentDescription.

Parameters:

service - a value to be removed

removeService

public boolean removeService(IDFServiceDescription service)

Remove a service from this ComponentDescription.

Parameters:

service - a value to be removed

Returns:

True when the services have changed.

getLeaseTime

public java.util.Date getLeaseTime()

Get the lease-time of this ComponentDescription.

Specified by:

getLeaseTime in interface IDFComponentDescription

Returns:

lease-time

setLeaseTime

public void setLeaseTime(java.util.Date leasetime)

Set the lease-time of this ComponentDescription.

Parameters:

leasetime - the value to be set

getProtocols

public java.lang.String[] getProtocols()

Get the protocols of this ComponentDescription.

Specified by:

getProtocols in interface IDFComponentDescription

Returns:

protocols

setProtocols

public void setProtocols(java.lang.String[] protocols)

Set the protocols of this ComponentDescription.

Parameters:

protocols - the value to be set

getProtocol

public java.lang.String getProtocol(int idx)

Get an protocols of this ComponentDescription.

Parameters:

idx - The index.

Returns:

protocols

setProtocol

public void setProtocol(int idx,
                        java.lang.String protocol)

Set a protocol to this ComponentDescription.

Parameters:

idx - The index.

protocol - a value to be added

addProtocol

public void addProtocol(java.lang.String protocol)

Add a protocol to this ComponentDescription.

Parameters:

protocol - a value to be removed

removeProtocol

public boolean removeProtocol(java.lang.String protocol)

Remove a protocol from this ComponentDescription.

Parameters:

protocol - a value to be removed

Returns:

True when the protocols have changed.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

Parameters:

obj -

Returns:

true if obj is an ComponentDescription and both are equal

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

clone

public java.lang.Object clone()

Clone a component description.

Overrides:

clone in class java.lang.Object

toString

public java.lang.String toString()

Get a string representation of this ComponentDescription.

Overrides:

toString in class java.lang.Object

Returns:

The string representation.