moos.ssds.model
Interface IDeployment

All Superinterfaces:
IDataProducer, IDateRange, IDescription, ResourceOwner, java.io.Serializable, ValueObject
All Known Implementing Classes:
Deployment

public interface IDeployment
extends java.io.Serializable, IDataProducer

Author:
kgomes To change the template for this generated type comment go to Window>Preferences>Java>Code Generation>Code and Comments

Field Summary
static java.lang.String INSTRUMENT_ROLE
          Description of the Field
static java.lang.String OBSERVATORY_ROLE
          Description of the Field
static java.lang.String PLATFORM_ROLE
          Description of the Field
static java.lang.String SENSOR_ROLE
          Description of the Field
 
Method Summary
 void addChildDeployment(IDeployment deployment)
          Adds a feature to the ChildDeployment attribute of the Deployment object
 java.util.Collection getChildDeployments()
          Gets the childDeployments attribute of the Deployment object
 IDevice getDevice()
          Gets the device attribute of the Deployment object
 java.lang.Long getDeviceId()
          Gets the deviceId attribute of the Deployment object
 java.lang.Long getMetadataId()
          Gets the metadataId attribute of the Deployment object
 java.lang.Float getNominalDepth()
           
 java.lang.Double getNominalLatitude()
           
 java.lang.Double getNominalLongitude()
           
 java.lang.String getOjbConcreteClass()
          Gets the ojbConcreteClass attribute of the Deployment object
 IDeployment getParentDeployment()
          Gets the parentDeployment attribute of the Deployment object
 java.lang.Long getParentId()
          Gets the parentId attribute of the Deployment object
 java.lang.String getRole()
          Gets the role attribute of the Deployment object
 IX3DLocation getX3DLocation()
          Gets the x3DLocation attribute of the Deployment object
 java.util.Collection listAllOutputsInclChildren()
           
 java.util.Collection listChildDeployments()
          List all child Deployments from this deployment
 java.util.Collection listChildDeployments(java.lang.String role)
          List child Deployments that have Role role from this deployment
 java.util.Collection listDerivedOutputsInclChildren()
          Lists outputs that were derived from outputs in this deployment, it's child deployments and any descendants Deployments (grand-children, great-grandchildren, etc)
 java.util.Collection listOutputsInclChildren()
          List outputs from this deployment, any contained child Deployments, and any descendants Deployments (grand-children, great grandchildren, etc)
 void removeChildDeployment(IDeployment deployment)
          Description of the Method
 void setChildDeployments(java.util.Collection children)
          Sets the childDeployments attribute of the Deployment object
 void setDevice(IDevice newDevice)
          Sets the device attribute of the Deployment object
 void setDeviceId(java.lang.Long device_id)
          Sets the deviceId attribute of the Deployment object
 void setMetadataId(java.lang.Long metadataId)
          Sets the metadataId attribute of the Deployment object
 void setNominalDepth(java.lang.Float nominalDepth)
           
 void setNominalLatitude(java.lang.Double nominalLatitude)
           
 void setNominalLongitude(java.lang.Double nominalLongitude)
           
 void setOjbConcreteClass(java.lang.String ojbConcreteClass)
          Sets the ojbConcreteClass attribute of the Deployment object
 void setParentDeployment(IDeployment parent)
           
 void setParentId(java.lang.Long parent_id)
          Sets the parentId attribute of the Deployment object
 void setRole(java.lang.String role)
          Sets the role attribute of the Deployment object
 void setX3DLocation(IX3DLocation x3DLocation)
          Sets the x3DLocation attribute of the Deployment object
 java.lang.String toString()
          Description of the Method
 
Methods inherited from interface moos.ssds.model.IDataProducer
addEvent, addInput, addOutput, addResource, getContact, getContactId, getDateRange, getDescription, getEndDate, getId, getName, getStartDate, listAllOutputs, listBestOutput, listDerivedOutputs, listEvents, listInputs, listOutputs, listResources, removeEvent, removeInput, removeOutput, removeResource, setContact, setContactId, setDescription, setEndDate, setId, setName, setStartDate
 

Field Detail

INSTRUMENT_ROLE

public static final java.lang.String INSTRUMENT_ROLE
Description of the Field

See Also:
Constant Field Values

OBSERVATORY_ROLE

public static final java.lang.String OBSERVATORY_ROLE
Description of the Field

See Also:
Constant Field Values

PLATFORM_ROLE

public static final java.lang.String PLATFORM_ROLE
Description of the Field

See Also:
Constant Field Values

SENSOR_ROLE

public static final java.lang.String SENSOR_ROLE
Description of the Field

See Also:
Constant Field Values
Method Detail

addChildDeployment

public void addChildDeployment(IDeployment deployment)
Adds a feature to the ChildDeployment attribute of the Deployment object

Parameters:
deployment - The feature to be added to the ChildDeployment attribute

getChildDeployments

public java.util.Collection getChildDeployments()
Gets the childDeployments attribute of the Deployment object

Returns:
The childDeployments value

getDevice

public IDevice getDevice()
Gets the device attribute of the Deployment object

Returns:
The device value

getDeviceId

public java.lang.Long getDeviceId()
Gets the deviceId attribute of the Deployment object

Returns:
The deviceId value

getMetadataId

public java.lang.Long getMetadataId()
Gets the metadataId attribute of the Deployment object

Returns:
The metadataId value

getOjbConcreteClass

public java.lang.String getOjbConcreteClass()
Gets the ojbConcreteClass attribute of the Deployment object

Specified by:
getOjbConcreteClass in interface IDataProducer
Returns:
The ojbConcreteClass value

setParentDeployment

public void setParentDeployment(IDeployment parent)

getParentDeployment

public IDeployment getParentDeployment()
Gets the parentDeployment attribute of the Deployment object

Returns:
The parentDeployment value

getParentId

public java.lang.Long getParentId()
Gets the parentId attribute of the Deployment object

Returns:
The parentId value

getRole

public java.lang.String getRole()
Gets the role attribute of the Deployment object

Returns:
The role value

getX3DLocation

public IX3DLocation getX3DLocation()
Gets the x3DLocation attribute of the Deployment object

Returns:
The x3DLocation value

listAllOutputsInclChildren

public java.util.Collection listAllOutputsInclChildren()
Returns:
A Collection of DataContainers the includes the outputs of this Deployment and all Descendant Deployments (i.e Children, grandchildren, etc) as well as the derived products of this Deployment and its descendants.

listChildDeployments

public java.util.Collection listChildDeployments()
List all child Deployments from this deployment

Returns:
copy of all child Deployments

listChildDeployments

public java.util.Collection listChildDeployments(java.lang.String role)
List child Deployments that have Role role from this deployment

Parameters:
role - Description of the Parameter
Returns:
copy of child Deployments with role

listDerivedOutputsInclChildren

public java.util.Collection listDerivedOutputsInclChildren()
Lists outputs that were derived from outputs in this deployment, it's child deployments and any descendants Deployments (grand-children, great-grandchildren, etc)

Returns:
A collection of DataContainers derived from the outputs of this deployment and its child deployments.

listOutputsInclChildren

public java.util.Collection listOutputsInclChildren()
List outputs from this deployment, any contained child Deployments, and any descendants Deployments (grand-children, great grandchildren, etc)

Returns:
outputs from this deployment and any child Deployments

removeChildDeployment

public void removeChildDeployment(IDeployment deployment)
Description of the Method

Parameters:
deployment - Description of the Parameter

setChildDeployments

public void setChildDeployments(java.util.Collection children)
Sets the childDeployments attribute of the Deployment object

Parameters:
children - The new childDeployments value

setDevice

public void setDevice(IDevice newDevice)
Sets the device attribute of the Deployment object

Parameters:
newDevice - The new device value

setDeviceId

public void setDeviceId(java.lang.Long device_id)
Sets the deviceId attribute of the Deployment object

Parameters:
device_id - The new deviceId value

setMetadataId

public void setMetadataId(java.lang.Long metadataId)
Sets the metadataId attribute of the Deployment object

Parameters:
metadataId - The new metadataId value

setOjbConcreteClass

public void setOjbConcreteClass(java.lang.String ojbConcreteClass)
Sets the ojbConcreteClass attribute of the Deployment object

Specified by:
setOjbConcreteClass in interface IDataProducer
Parameters:
ojbConcreteClass - The new ojbConcreteClass value

setParentId

public void setParentId(java.lang.Long parent_id)
Sets the parentId attribute of the Deployment object

Parameters:
parent_id - The new parentId value

setRole

public void setRole(java.lang.String role)
Sets the role attribute of the Deployment object

Parameters:
role - The new role value

setX3DLocation

public void setX3DLocation(IX3DLocation x3DLocation)
Sets the x3DLocation attribute of the Deployment object

Parameters:
x3DLocation - The new x3DLocation value

toString

public java.lang.String toString()
Description of the Method

Returns:
Description of the Return Value

getNominalLatitude

public java.lang.Double getNominalLatitude()

setNominalLatitude

public void setNominalLatitude(java.lang.Double nominalLatitude)

getNominalLongitude

public java.lang.Double getNominalLongitude()

setNominalLongitude

public void setNominalLongitude(java.lang.Double nominalLongitude)

getNominalDepth

public java.lang.Float getNominalDepth()

setNominalDepth

public void setNominalDepth(java.lang.Float nominalDepth)