ObjectDescription (POPJava 1.5 API)

java.lang.Object
- ch.icosys.popjava.core.baseobject.ObjectDescription

All Implemented Interfaces:

IPOPBase
```
public class ObjectDescription
extends java.lang.Object
implements IPOPBase
```
This class represents the object description for a parallel object. The object description is the resource requirements for a specific parallel object.

Field Summary

Fields
Modifier and Type	Field and Description
`protected float`	`bandwidthMin`
`protected float`	`bandwidthReq`
`protected java.lang.String`	`batch`
`protected java.lang.String`	`codeFile`
`protected java.lang.String`	`connectionSecret`
`protected ConnectionType`	`connectionType`
`protected static java.lang.String`	`CONNECTOR_KEY`
`protected java.lang.String`	`directory`
`protected java.lang.String`	`encoding`
`protected java.lang.String`	`hostarch`
`protected java.lang.String`	`hostcore`
`protected java.lang.String`	`hostName`
`protected java.lang.String`	`hostuser`
`protected boolean`	`isLocalJob`
`protected boolean`	`isManual`
`protected java.lang.String`	`jobUrl`
`protected java.lang.String`	`jvmParamters`
`protected int`	`maxDepth`
`protected int`	`maxSize`
`protected float`	`memoryMin`
`protected float`	`memoryReq`
`protected static java.lang.String`	`NETWORK_KEY`
`protected POPAccessPoint`	`originAppService`
`protected java.lang.String`	`platform`
`protected float`	`powerMin`
`protected float`	`powerReq`
`protected java.lang.String[]`	`protocols`
`protected java.lang.String`	`remoteAccessPoint`
`protected java.util.List<java.lang.String>`	`searchHosts`
`protected boolean`	`searchSet`
`protected boolean`	`tracking`
`protected boolean`	`upnp`
`protected java.lang.Boolean`	`useLocalJVM`
`protected int`	`waitTime`
`protected float`	`wallTime`

Constructor Summary

Constructors
Constructor and Description

ObjectDescription()
Create a new empty instance of ObjectDescription

ObjectDescription(ObjectDescription od)

Constructors
Constructor and Description
`ObjectDescription()` Create a new empty instance of ObjectDescription
`ObjectDescription(ObjectDescription od)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addSearchHosts(java.lang.String searchHost)` Add an host to the OD, see `setSearchHosts(java.lang.String...)`
`boolean`	`deserialize(POPBuffer buffer)` Deserialize the object description from the buffer
`float`	`getBandwidthMin()`
`float`	`getBandwidthReq()`
`java.lang.String`	`getBatch()` Get the OD batch value
`java.lang.String`	`getCodeFile()` Get the OD code file value
`java.lang.String`	`getConnectionSecret()`
`ConnectionType`	`getConnectionType()` Returns the connection type to be used if the object has to be run remotely
`java.lang.String`	`getConnector()` Job Manager connector to use
`java.lang.String`	`getDirectory()` Get the directory we want the process to run into
`java.lang.String`	`getEncoding()` Get the OD encoding value
`java.lang.String`	`getHostarch()` Get the OD host architecture value
`java.lang.String`	`getHostcore()` Get the OD host core value
`java.lang.String`	`getHostName()` Get the OD hostname value
`java.lang.String`	`getHostuser()` Get the OD host user value
`java.lang.String`	`getJobUrl()` Get the OD JobUrl value
`java.lang.String`	`getJVMParameters()` Returns the parameters that should be used when creating the JVM for this object
`float`	`getMemoryMin()`
`float`	`getMemoryReq()`
`java.lang.String`	`getNetwork()` The network to use for this request
`POPAccessPoint`	`getOriginAppService()`
`java.lang.String`	`getPlatform()` Get he OD platform value
`float`	`getPowerMin()` Get the OD bandwith value
`float`	`getPowerReq()`
`java.lang.String[]`	`getProtocols()` Get the OD protocol value
`java.lang.String`	`getRemoteAccessPoint()`
`java.lang.String[]`	`getSearchHosts()` The hosts which should answer a request.
`int`	`getSearchMaxDepth()` Get the OD search maximum depth value
`int`	`getSearchMaxSize()` Get the OD search maximum size value
`int`	`getSearchWaitTime()` Get the OD search waiting time value
`java.lang.String`	`getValue(java.lang.String key)` Get a specific attribute from the list
`float`	`getWallTime()` Get the OD walltime value
`boolean`	`isEmpty()` Check if the current object is empty
`boolean`	`isSearchSet()` Say if the OD search is set
`boolean`	`isTracking()`
`boolean`	`isUPNPEnabled()`
`void`	`manual(boolean a)` Set the manual OD
`void`	`merge(ObjectDescription od)` Merge another object description with this object description
`void`	`removeAllAttributes()` Remove all attributes from the list
`void`	`removeValue(java.lang.String key)` Remove a specific attribute from the list
`boolean`	`serialize(POPBuffer buffer)` Serialize the object description into the buffer
`void`	`setBandwidth(float required, float min)` Set the bandwidth OD by values
`void`	`setBatch(java.lang.String batch)` Set the OD batch value
`void`	`setCodeFile(java.lang.String codeFile)` Set the OD Code file value
`void`	`setConnectionSecret(java.lang.String secret)` Sets the secret key to be used to connect to this object.
`void`	`setConnectionType(ConnectionType type)` Sets the connection type to be used if the object has to be created remotely
`void`	`setConnector(java.lang.String connector)` Job Manager connector to use
`void`	`setDirectory(java.lang.String d)` Set the directory OD
`void`	`setEncoding(java.lang.String encoding)` Set the OD encoding value
`void`	`setHostarch(java.lang.String arch)` Set the OD host architecture value
`void`	`setHostcore(java.lang.String core)` Set the OD host core value
`void`	`setHostname(java.lang.String hostname)` Set the OD host name value
`void`	`setHostuser(java.lang.String user)` Set the OD host user value
`void`	`setJobUrl(java.lang.String jobUrl)` Set the OD JobUrl value
`void`	`setJVMParamters(java.lang.String parameters)` Sets the jvm parameters that should be used when creating this object
`void`	`setMemory(float required, float min)` Set the memory OD by values
`void`	`setNetwork(java.lang.String network)` Specify network name to use
`void`	`setOriginAppService(POPAccessPoint originAppService)`
`void`	`setPlatform(java.lang.String platform)` Set the OD platform value
`void`	`setPower(float required, float min)` Set the power OD by values
`void`	`setProtocols(java.lang.String[] protocols)` Set the OD protocol value
`void`	`setRemoteAccessPoint(java.lang.String accessPoint)`
`void`	`setSearch(int maxdepth, int maxsize, int waittime)` Set the search OD values
`void`	`setSearchHosts(java.lang.String... searchHosts)` Set the OD to tell that only the specified hosts should answer.
`void`	`setTracking(boolean tracking)`
`void`	`setUPNP(boolean upnp)`
`void`	`setUseLocalJVM(boolean localJVM)`
`void`	`setValue(java.lang.String key, java.lang.String value)` Set a specific attribute in the list
`void`	`setWallTime(float walltime)` Set the walltime OD
`java.lang.String`	`toString()` Format the object description as a string value
`boolean`	`useLocalJVM()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - isLocalJob
```
protected boolean isLocalJob
```
  - isManual
```
protected boolean isManual
```
  - maxDepth
```
protected int maxDepth
```
  - waitTime
```
protected int waitTime
```
  - maxSize
```
protected int maxSize
```
  - searchSet
```
protected boolean searchSet
```
  - hostarch
```
protected java.lang.String hostarch
```
  - hostcore
```
protected java.lang.String hostcore
```
  - hostuser
```
protected java.lang.String hostuser
```
  - powerMin
```
protected float powerMin
```
  - powerReq
```
protected float powerReq
```
  - bandwidthMin
```
protected float bandwidthMin
```
  - bandwidthReq
```
protected float bandwidthReq
```
  - memoryMin
```
protected float memoryMin
```
  - memoryReq
```
protected float memoryReq
```
  - wallTime
```
protected float wallTime
```
  - encoding
```
protected java.lang.String encoding
```
  - protocols
```
protected java.lang.String[] protocols
```
  - platform
```
protected java.lang.String platform
```
  - hostName
```
protected java.lang.String hostName
```
  - jobUrl
```
protected java.lang.String jobUrl
```
  - codeFile
```
protected java.lang.String codeFile
```
  - directory
```
protected java.lang.String directory
```
  - batch
```
protected java.lang.String batch
```
  - searchHosts
```
protected java.util.List<java.lang.String> searchHosts
```
  - remoteAccessPoint
```
protected java.lang.String remoteAccessPoint
```
  - originAppService
```
protected POPAccessPoint originAppService
```
  - NETWORK_KEY
```
protected static final java.lang.String NETWORK_KEY
```
    See Also:
    
    Constant Field Values
  - CONNECTOR_KEY
```
protected static final java.lang.String CONNECTOR_KEY
```
    See Also:
    
    Constant Field Values
  - jvmParamters
```
protected java.lang.String jvmParamters
```
  - connectionType
```
protected ConnectionType connectionType
```
  - connectionSecret
```
protected java.lang.String connectionSecret
```
  - useLocalJVM
```
protected java.lang.Boolean useLocalJVM
```
  - tracking
```
protected boolean tracking
```
  - upnp
```
protected boolean upnp
```
- Constructor Detail
  - ObjectDescription
```
public ObjectDescription()
```
    Create a new empty instance of ObjectDescription
  - ObjectDescription
```
public ObjectDescription(ObjectDescription od)
```
- Method Detail
  - useLocalJVM
```
public boolean useLocalJVM()
```
  - setUseLocalJVM
```
public void setUseLocalJVM(boolean localJVM)
```
  - setDirectory
```
public void setDirectory(java.lang.String d)
```
    Set the directory OD
    
    Parameters:
    
    d - Specific directory
  - getDirectory
```
public java.lang.String getDirectory()
```
    Get the directory we want the process to run into
    
    Returns:
    
    the directory
  - setPower
```
public void setPower(float required,
                     float min)
```
    Set the power OD by values
    
    Parameters:
    
    required - The required power
    
    min - The minimum power
  - setMemory
```
public void setMemory(float required,
                      float min)
```
    Set the memory OD by values
    
    Parameters:
    
    required - The required memory
    
    min - The minimum memory
  - setBandwidth
```
public void setBandwidth(float required,
                         float min)
```
    Set the bandwidth OD by values
    
    Parameters:
    
    required - The required bandwidth
    
    min - The minimum bandwidth
  - setWallTime
```
public void setWallTime(float walltime)
```
    Set the walltime OD
    
    Parameters:
    
    walltime - time allocated for the wall execution
  - setSearchHosts
```
public void setSearchHosts(java.lang.String... searchHosts)
```
    Set the OD to tell that only the specified hosts should answer.
    
    Parameters:
    
    searchHosts - which hosts should respond to our inquiry
  - addSearchHosts
```
public void addSearchHosts(java.lang.String searchHost)
```
    Add an host to the OD, see setSearchHosts(java.lang.String...)
    
    Parameters:
    
    searchHost - which hosts should respond to our inquiry
  - getSearchHosts
```
public java.lang.String[] getSearchHosts()
```
    The hosts which should answer a request.
    
    Returns:
    
    the only hosts that should answer a lookup
  - manual
```
public void manual(boolean a)
```
    Set the manual OD
    
    Parameters:
    
    a - true = manual
  - setSearch
```
public void setSearch(int maxdepth,
                      int maxsize,
                      int waittime)
```
    Set the search OD values
    
    Parameters:
    
    maxdepth - The maximum depth for the search algorithm
    
    maxsize - The maximum size of a search request
    
    waittime - The waiting time of the search algorithm (0 = take the first answer)
  - getSearchMaxDepth
```
public int getSearchMaxDepth()
```
    Get the OD search maximum depth value
    
    Returns:
    
    maximum depth value set in the OD
  - getSearchMaxSize
```
public int getSearchMaxSize()
```
    Get the OD search maximum size value
    
    Returns:
    
    maximum size value set in the OD
  - getSearchWaitTime
```
public int getSearchWaitTime()
```
    Get the OD search waiting time value
    
    Returns:
    
    waiting time value set in the OD
  - isSearchSet
```
public boolean isSearchSet()
```
    Say if the OD search is set
    
    Returns:
    
    true if the OD search is set
  - setHostname
```
public void setHostname(java.lang.String hostname)
```
    Set the OD host name value
    
    Parameters:
    
    hostname - host name to execute the object
  - setHostarch
```
public void setHostarch(java.lang.String arch)
```
    Set the OD host architecture value
    
    Parameters:
    
    arch - host architecture to execute the object
  - getHostarch
```
public java.lang.String getHostarch()
```
    Get the OD host architecture value
    
    Returns:
    
    host architecture value set in the OD
  - setHostcore
```
public void setHostcore(java.lang.String core)
```
    Set the OD host core value
    
    Parameters:
    
    core - core value
  - getHostcore
```
public java.lang.String getHostcore()
```
    Get the OD host core value
    
    Returns:
    
    host core value set in this OD
  - setHostuser
```
public void setHostuser(java.lang.String user)
```
    Set the OD host user value
    
    Parameters:
    
    user - USer to execute the object
  - getHostuser
```
public java.lang.String getHostuser()
```
    Get the OD host user value
    
    Returns:
    
    host user value set in this OD
  - setBatch
```
public void setBatch(java.lang.String batch)
```
    Set the OD batch value
    
    Parameters:
    
    batch - batch value
  - getBatch
```
public java.lang.String getBatch()
```
    Get the OD batch value
    
    Returns:
    
    batch value set in this OD
  - setJobUrl
```
public void setJobUrl(java.lang.String jobUrl)
```
    Set the OD JobUrl value
    
    Parameters:
    
    jobUrl - job manager access point
  - setCodeFile
```
public void setCodeFile(java.lang.String codeFile)
```
    Set the OD Code file value
    
    Parameters:
    
    codeFile - Get the OD code file value
  - setProtocols
```
public void setProtocols(java.lang.String[] protocols)
```
    Set the OD protocol value
    
    Parameters:
    
    protocols - protocol to be used to communicate with the object
  - setEncoding
```
public void setEncoding(java.lang.String encoding)
```
    Set the OD encoding value
    
    Parameters:
    
    encoding - encoding to be used to communicate with the object
  - setPlatform
```
public void setPlatform(java.lang.String platform)
```
    Set the OD platform value
    
    Parameters:
    
    platform - platform on which the object must be executed
  - setJVMParamters
```
public void setJVMParamters(java.lang.String parameters)
```
    Sets the jvm parameters that should be used when creating this object
    
    Parameters:
    
    parameters - the jvm parameters
  - setConnectionType
```
public void setConnectionType(ConnectionType type)
```
    Sets the connection type to be used if the object has to be created remotely
    
    Parameters:
    
    type - the type of connection
  - setConnectionSecret
```
public void setConnectionSecret(java.lang.String secret)
```
    Sets the secret key to be used to connect to this object. This option only makes sense when the POP-Java deamon connection type is used
    
    Parameters:
    
    secret - the connection secret
  - getPowerMin
```
public float getPowerMin()
```
    Get the OD bandwith value
    
    Returns:
    
    bandwith value set in this OD
  - getPowerReq
```
public float getPowerReq()
```
  - getMemoryMin
```
public float getMemoryMin()
```
  - getMemoryReq
```
public float getMemoryReq()
```
  - getBandwidthMin
```
public float getBandwidthMin()
```
  - getBandwidthReq
```
public float getBandwidthReq()
```
  - getWallTime
```
public float getWallTime()
```
    Get the OD walltime value
    
    Returns:
    
    walltime value set in this OD
  - getHostName
```
public java.lang.String getHostName()
```
    Get the OD hostname value
    
    Returns:
    
    hostname set in this OD
  - getJobUrl
```
public java.lang.String getJobUrl()
```
    Get the OD JobUrl value
    
    Returns:
    
    joburl set in this OD
  - getProtocols
```
public java.lang.String[] getProtocols()
```
    Get the OD protocol value
    
    Returns:
    
    protocol set in this OD
  - getEncoding
```
public java.lang.String getEncoding()
```
    Get the OD encoding value
    
    Returns:
    
    encoding set in this OD
  - getJVMParameters
```
public java.lang.String getJVMParameters()
```
    Returns the parameters that should be used when creating the JVM for this object
    
    Returns:
    
    the jvm parameters
  - getConnectionType
```
public ConnectionType getConnectionType()
```
    Returns the connection type to be used if the object has to be run remotely
    
    Returns:
    
    the connection type
  - getConnectionSecret
```
public java.lang.String getConnectionSecret()
```
  - getPlatform
```
public java.lang.String getPlatform()
```
    Get he OD platform value
    
    Returns:
    
    platform set in this OD
  - getCodeFile
```
public java.lang.String getCodeFile()
```
    Get the OD code file value
    
    Returns:
    
    codefile set in this OD
  - getNetwork
```
public java.lang.String getNetwork()
```
    The network to use for this request
    
    Returns:
    
    the specified network
  - setNetwork
```
public void setNetwork(java.lang.String network)
```
    Specify network name to use
    
    Parameters:
    
    network - the new network
  - getConnector
```
public java.lang.String getConnector()
```
    Job Manager connector to use
    
    Returns:
    
    the connector to use for object creation
  - setConnector
```
public void setConnector(java.lang.String connector)
```
    Job Manager connector to use
    
    Parameters:
    
    connector - the connector to use for object creation
  - setValue
```
public void setValue(java.lang.String key,
                     java.lang.String value)
```
    Set a specific attribute in the list
    
    Parameters:
    
    key - Key for this attribute
    
    value - value for this attribute
  - getValue
```
public java.lang.String getValue(java.lang.String key)
```
    Get a specific attribute from the list
    
    Parameters:
    
    key - Key of the specific attribute
    
    Returns:
    
    Value of the attribute or an empty string
  - removeValue
```
public void removeValue(java.lang.String key)
```
    Remove a specific attribute from the list
    
    Parameters:
    
    key - Key of the attribute to be removed
  - removeAllAttributes
```
public void removeAllAttributes()
```
    Remove all attributes from the list
  - setRemoteAccessPoint
```
public void setRemoteAccessPoint(java.lang.String accessPoint)
```
  - getRemoteAccessPoint
```
public java.lang.String getRemoteAccessPoint()
```
  - getOriginAppService
```
public POPAccessPoint getOriginAppService()
```
  - setOriginAppService
```
public void setOriginAppService(POPAccessPoint originAppService)
```
  - setTracking
```
public void setTracking(boolean tracking)
```
  - isTracking
```
public boolean isTracking()
```
  - setUPNP
```
public void setUPNP(boolean upnp)
```
  - isUPNPEnabled
```
public boolean isUPNPEnabled()
```
  - isEmpty
```
public boolean isEmpty()
```
    Check if the current object is empty
    
    Returns:
    
    true if empty
  - deserialize
```
public boolean deserialize(POPBuffer buffer)
```
    Deserialize the object description from the buffer
    
    Specified by:
    
    deserialize in interface IPOPBase
    
    Parameters:
    
    buffer - The buffer to deserialize from
    
    Returns:
    
    true if the deserialization process succeed
  - serialize
```
public boolean serialize(POPBuffer buffer)
```
    Serialize the object description into the buffer
    
    Specified by:
    
    serialize in interface IPOPBase
    
    Parameters:
    
    buffer - The buffer to serialize in
    
    Returns:
    
    true if the serialization process succeed
  - merge
```
public void merge(ObjectDescription od)
```
    Merge another object description with this object description
    
    Parameters:
    
    od - The object description to be merged with this one
  - toString
```
public java.lang.String toString()
```
    Format the object description as a string value
    
    Overrides:
    
    toString in class java.lang.Object

Class ObjectDescription

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

isLocalJob

isManual

maxDepth

waitTime

maxSize

searchSet

hostarch

hostcore

hostuser

powerMin

powerReq

bandwidthMin

bandwidthReq

memoryMin

memoryReq

wallTime

encoding

protocols

platform

hostName

jobUrl

codeFile

directory

batch

searchHosts

remoteAccessPoint

originAppService

NETWORK_KEY

CONNECTOR_KEY

jvmParamters

connectionType

connectionSecret

useLocalJVM

tracking

upnp

Constructor Detail

ObjectDescription

ObjectDescription

Method Detail

useLocalJVM

setUseLocalJVM

setDirectory

getDirectory

setPower

setMemory

setBandwidth

setWallTime

setSearchHosts

addSearchHosts

getSearchHosts

manual

setSearch

getSearchMaxDepth

getSearchMaxSize

getSearchWaitTime

isSearchSet

setHostname

setHostarch

getHostarch

setHostcore

getHostcore

setHostuser

getHostuser

setBatch

getBatch

setJobUrl

setCodeFile

setProtocols

setEncoding

setPlatform

setJVMParamters

setConnectionType

setConnectionSecret

getPowerMin