org.optimizationservices.oscommon.localinterface
Class OSEntity

java.lang.Object
  org.optimizationservices.oscommon.localinterface.OSEntity

public class OSEntity
extends java.lang.Object

The OSEntity class is a local interface for storing Optimization Services entity. Its design follows the Optimization Services entity Language (OSeL). All the data structures in this class are standards specified in OSeL.

Since:

OS 1.0

Version:

1.0, 03/14/2005

Author:

Robert Fourer, Jun Ma, Kipp Martin

Field Summary

EntityData	entityData entityData holds the second child of the OSEntity specified by the OSeL Schema.
EntityHeader	entityHeader entityHeader holds the first child of the OSEntity specified by the OSeL Schema.

Constructor Summary

OSEntity()
Default constructor.

Method Summary

AccessLimits	getAccessLimits() Get the access limits of the service.
OSOption	getDefaultOptionNamesAndValues() Get the default option names and values in the standard OSOption structure which is specified by the OSoL schema.
java.lang.String[]	getKeyWords() Get the key words of the service.
boolean	getLicenseRequired() Get whether the license is reqired of the service or not.
Link[]	getLinks() Get the links of the service.
java.lang.String	getMessage() Get the message.
java.lang.String	getOptimizationConstraintDifferentiability() Get the optimization constraint differentiability, which can be: generallyDifferentiable, twiceDifferentiable, firstDifferentiable, nonDifferentiableContinous, nonContinuous, simulation.
java.lang.String	getOptimizationConstraintLinearity() Get the constraint objective linearity, which can be: none, bound, linearNetwork, linear, convexQuadratic, convexNonlinear, generalQuadratic, generalNonlinear
java.lang.String	getOptimizationConstraintType() Get the optimization constraint type, which can be: generalRange, pureEquality, pureBound, pureLinearComplementarity, pureNonlinearComplementarity, linearMixedComplementarity, nonlinearMixedComplementarity, generalMixedComplementarity, pureCone, mixedCone.
java.lang.String	getOptimizationDescription() Get the optimization description.
FunctionType	getOptimizationFunctionType() Get the function types that the service supports.
java.lang.String	getOptimizationObjectiveDifferentiability() Get the optimization objective differentiability, which can be: generallyDifferentiable, twiceDifferentiable, firstDifferentiable, nonDifferentiableContinous, nonContinuous, simulation.
java.lang.String	getOptimizationObjectiveLinearity() Get the optimization objective linearity, which can be: none, linearNetwork, linear, sumOfSquares, convexQuadratic, convexNonlinear, generalQuadratic, generalNonlinear
java.lang.String	getOptimizationObjectiveType() Get the optimization objective type, which can be: none, singleObjective, multiObjectives
java.lang.String	getOptimizationParameterType() Get the optimization parameter type, which can be: number, string, both
boolean	getOptimizationRealTime() Get whether the service supports real time optimization or not.
SpecialAlgorithm	getOptimizationSpecialAlgorithm() Get the special algorithms that the service supports.
SpecialStructure	getOptimizationSpecialStructure() Get the special structures that the service supports.
java.lang.String	getOptimizationStochasticity() Get the optimization stochasticity, which can be: deterministic, stochastic, both
java.lang.String	getOptimizationVariableType() Get the optimization variable type, which can be: continuous, pureBinary, mixedBinary, pureInteger, mixedInteger, discrete.
java.util.Hashtable<java.lang.String,java.lang.String>	getOtherEntityInfoDescriptions() get a hashmap of other entity info descriptions.
java.lang.String[]	getOtherEntityInfoNames() get a string array of names of other entity info.
java.util.Hashtable<java.lang.String,java.lang.String>	getOtherEntityInfoValues() get a hashmap of other entity info values.
Owner	getOwner() Get the owner information of the service entity.
boolean	getPasswordRequired() Get whether the password is reqired of the service or not.
java.util.GregorianCalendar	getRegistrationDate() Get time of the registration date.
java.lang.String	getServiceAlgorithmDescription() Get the service algorithm description.
java.lang.String	getServiceCategory() Get the service category, which can be: education, government, organization, company, military, personal, other
java.lang.String	getServiceDescription() Get the service description.
java.lang.String	getServiceLogoImageLink() Get the service logo image link.
java.lang.String	getServiceName() Get service name.
java.lang.String	getServiceSoftwareDescription() Get the service software description.
java.lang.String	getServiceType() Get the service type, which can be: solver, analyzer, scheduler, simulation, registry, modeler, agent
java.lang.String	getServiceURI() Get service uri.
java.lang.String	getServiceWebPage() Get the service web page.
java.lang.String	getServiceWSDLLocation() Get the service wsdl location.
double	getSystemDedication() Get the system dedication, a double between 0 and 1 with 1 being fully dedicated.
java.lang.String	getSystemDescription() Get the system description.
HardwareInfo	getSystemHardwareInfo() Get the system hardware information.
boolean	getUserNameRequired() Get whether the user name is reqired of the service or not.
static void	main(java.lang.String[] args) main for test purposes.
OSEntity	readOSeL(java.lang.String osel, boolean isFile, boolean validate) read an OSeL instance and return and OSEntity object.
boolean	setAccessLimits(AccessLimits accessLimits) Set the access limit information of the service entity.
boolean	setDefaultOptionNamesAndValues(OSOption osOption) Set the default option names and values in the standard OSOption structure which is specified by the OSoL schema.
boolean	setKeyWords(java.lang.String[] keyWords) Set the key words of the service.
boolean	setLicenseRequired(boolean licenseRequired) Set whether the license is reqired of the service or not.
boolean	setLinks(Link[] links) Set the links of the service.
boolean	setMessage(java.lang.String message) Set the message.
boolean	setOptimizationConstraintDifferentiability(java.lang.String constraintDifferentiability) Set the optimization constraint differentiability.
boolean	setOptimizationConstraintLinearity(java.lang.String constraintLinearity) Set the optimization constraint linearity.
boolean	setOptimizationConstraintType(java.lang.String constraintType) Set the optimization constraint type.
boolean	setOptimizationDescription(java.lang.String description) Set the optimization description.
boolean	setOptimizationFunctionType(FunctionType functionType) Set the function types that the service supports.
boolean	setOptimizationObjectiveDifferentiability(java.lang.String objectiveDifferentiability) Set the optimization objective differentiability.
boolean	setOptimizationObjectiveLinearity(java.lang.String objectiveLinearity) Set the optimization objective linearity.
boolean	setOptimizationObjectiveType(java.lang.String objectiveType) Set the optimization objective type.
boolean	setOptimizationParameterType(java.lang.String parameterType) Set the optimization parameter type.
boolean	setOptimizationRealTime(boolean realTime) Set whether the service supports real time optimization or not.
boolean	setOptimizationSpecialAlgorithm(SpecialAlgorithm specialAlgorithm) Set the special algorithms that the service supports.
boolean	setOptimizationSpecialStructure(SpecialStructure specialStructure) Set the special structures that the service supports.
boolean	setOptimizationStochasticity(java.lang.String stochasticity) Set the optimization stochasticity.
boolean	setOptimizationVariableType(java.lang.String variableType) Set the optimization variable type.
boolean	setOtherEntityInfo(java.lang.String[] names, java.lang.String[] descriptions, java.lang.String[] values) set other entity info, with their names (required), descriptions (optional) and values (optional).
boolean	setOwner(Owner owner) Set the owner information of the service entity.
boolean	setPasswordRequired(boolean passwordRequired) Set whether the password is reqired of the service or not.
boolean	setRegistrationDate(java.util.GregorianCalendar date) Set time of the registration date.
boolean	setServiceAlgorithmDescription(java.lang.String algorithmDescription) Set the algorithm description.
boolean	setServiceCategory(java.lang.String category) Set the service category.
boolean	setServiceDescription(java.lang.String description) Set the service description.
boolean	setServiceLogoImageLink(java.lang.String logoImageLink) Set the service logo image link.
boolean	setServiceName(java.lang.String serviceName) Set service name.
boolean	setServiceSoftwareDescription(java.lang.String softwareDescription) Set the service software description.
boolean	setServiceType(java.lang.String type) Set the service type.
boolean	setServiceURI(java.lang.String serviceURI) Set service uri.
boolean	setServiceWebPage(java.lang.String webPage) Set the service web page.
boolean	setServiceWSDLLocation(java.lang.String wsdlLocation) Set the service wsdl location.
boolean	setSystemDedication(double dedication) Set the system dedication.
boolean	setSystemDescription(java.lang.String description) Set the system description.
boolean	setSystemHardwareInfo(HardwareInfo hardwareInfo) Set the system hardware information.
boolean	setUserNameRequired(boolean userNameRequired) Set whether the user name is reqired of the service or not.
java.lang.String	writeOSeL() write the OSEntity to an osel xml string.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

entityHeader

public EntityHeader entityHeader

entityHeader holds the first child of the OSEntity specified by the OSeL Schema.

entityData

public EntityData entityData

entityData holds the second child of the OSEntity specified by the OSeL Schema.

Constructor Detail

OSEntity

public OSEntity()

Default constructor.

Method Detail

readOSeL

public OSEntity readOSeL(java.lang.String osel,
                         boolean isFile,
                         boolean validate)
                  throws java.lang.Exception

read an OSeL instance and return and OSEntity object.

Parameters:

osel - holds the optimization entity in a string which format follows the Optimization Services entity Language (OSeL) schema.

isFile - holds whether the osel string is a file name or a string that literally holds the osel contents.

validate - holds whether the reader should be validating against the schema or not.

Returns:

the OSEntity object constructed from the OSeL String.

Throws:

java.lang.Exception - if there are errors in reading the string or setting the OSEntity.

writeOSeL

public java.lang.String writeOSeL()
                           throws java.lang.Exception

write the OSEntity to an osel xml string.

Returns:

the osel xml string.

Throws:

java.lang.Exception - if there are errors in writing the osel string.

getServiceName

public java.lang.String getServiceName()

Get service name.

Returns:

the service name.

setServiceName

public boolean setServiceName(java.lang.String serviceName)

Set service name.

Parameters:

serviceName - holds the name of the service.

Returns:

whether the service name is set successfully.

getServiceURI

public java.lang.String getServiceURI()

Get service uri.

Returns:

the service uri.

setServiceURI

public boolean setServiceURI(java.lang.String serviceURI)

Set service uri.

Parameters:

serviceURI - holds the uri of the service.

Returns:

whether the service uri is set successfully.

getRegistrationDate

public java.util.GregorianCalendar getRegistrationDate()

Get time of the registration date.

Returns:

the time of the registration date.

setRegistrationDate

public boolean setRegistrationDate(java.util.GregorianCalendar date)

Set time of the registration date.

Parameters:

date - holds the registration date.

Returns:

whether registration date is set successfully.

getMessage

public java.lang.String getMessage()

Get the message.

Returns:

the message.

setMessage

public boolean setMessage(java.lang.String message)

Set the message.

Parameters:

message - holds the message.

Returns:

whether the message is set successfully.

getLicenseRequired

public boolean getLicenseRequired()

Get whether the license is reqired of the service or not.

Returns:

whether the license is reqired of the service or not.

setLicenseRequired

public boolean setLicenseRequired(boolean licenseRequired)

Set whether the license is reqired of the service or not.

Parameters:

licenseRequired - holds whether the license is reqired of the service or not.

Returns:

whether the licenseRequired is set successfully or not.

getUserNameRequired

public boolean getUserNameRequired()

Get whether the user name is reqired of the service or not.

Returns:

whether the user name is reqired of the service or not.

setUserNameRequired

public boolean setUserNameRequired(boolean userNameRequired)

Set whether the user name is reqired of the service or not.

Parameters:

userNameRequired - holds whether the user name is reqired of the service or not.

Returns:

whether the userNameRequired is set successfully or not.

getPasswordRequired

public boolean getPasswordRequired()

Get whether the password is reqired of the service or not.

Returns:

whether the password is reqired of the service or not.

setPasswordRequired

public boolean setPasswordRequired(boolean passwordRequired)

Set whether the password is reqired of the service or not.

Parameters:

passwordRequired - holds whether the password is reqired of the service or not.

Returns:

whether the passwordRequired is set successfully or not.

getAccessLimits

public AccessLimits getAccessLimits()

Get the access limits of the service.

Returns:

the access limits information of the service entity; null if none.

setAccessLimits

public boolean setAccessLimits(AccessLimits accessLimits)

Set the access limit information of the service entity.

Parameters:

accessLimits - holds the access limit information.

Returns:

whether the access limit information is set successfully or not.

getOwner

public Owner getOwner()

Get the owner information of the service entity.

Returns:

the owner information of the service entity; null if none.

setOwner

public boolean setOwner(Owner owner)

Set the owner information of the service entity.

Parameters:

owner - holds the service owner.

Returns:

whether the owner information is set successfully or not.

getKeyWords

public java.lang.String[] getKeyWords()

Get the key words of the service.

Returns:

the key words in a string array; null if none.

setKeyWords

public boolean setKeyWords(java.lang.String[] keyWords)

Set the key words of the service.

Parameters:

keyWords - holds the service key words.

Returns:

whether the key words of the service are set successfully or not.

getLinks

public Link[] getLinks()

Get the links of the service.

Returns:

the links of the service; null if none.

setLinks

public boolean setLinks(Link[] links)

Set the links of the service.

Parameters:

links - holds a Link array of the service links.

Returns:

whether the links of the service are set successfully.

getSystemDescription

public java.lang.String getSystemDescription()

Get the system description.

Returns:

the system description; null or empty string if none.

setSystemDescription

public boolean setSystemDescription(java.lang.String description)

Set the system description.

Parameters:

description - holds the system description.

Returns:

whether the system description is set successfully or not.

getSystemDedication

public double getSystemDedication()

Get the system dedication, a double between 0 and 1 with 1 being fully dedicated.

Returns:

the system dedication; Double.NaN if none.

setSystemDedication

public boolean setSystemDedication(double dedication)

Set the system dedication.

Parameters:

dedication - holds the system dedication, a double between 0 and 1 with 1 being fully dedicated.

Returns:

whether the system dedication. is set successfully or not.

getSystemHardwareInfo

public HardwareInfo getSystemHardwareInfo()

Get the system hardware information.

Returns:

the system hardware information; null if none.

setSystemHardwareInfo

public boolean setSystemHardwareInfo(HardwareInfo hardwareInfo)

Set the system hardware information.

Parameters:

hardwareInfo - holds the system hardware information.

Returns:

whether the system hardware information is set successfully or not.

getServiceDescription

public java.lang.String getServiceDescription()

Get the service description.

Returns:

the service description; null or empty string if none.

setServiceDescription

public boolean setServiceDescription(java.lang.String description)

Set the service description.

Parameters:

description - holds the service description.

Returns:

whether the service description is set successfully or not.

getServiceType

public java.lang.String getServiceType()

Get the service type, which can be: solver, analyzer, scheduler, simulation, registry, modeler, agent

Returns:

the service type; null or empty string if none.

setServiceType

public boolean setServiceType(java.lang.String type)

Set the service type.

Parameters:

type - holds the service type, which can be: solver, analyzer, scheduler, simulation, registry, modeler, agent

Returns:

whether the service type is set successfully or not.

getServiceCategory

public java.lang.String getServiceCategory()

Get the service category, which can be: education, government, organization, company, military, personal, other

Returns:

the service category; null or empty string if none.

setServiceCategory

public boolean setServiceCategory(java.lang.String category)

Set the service category.

Parameters:

category - holds the service category, which can be: education, government, organization, company, military, personal, other

Returns:

whether the service category is set successfully or not.

getServiceSoftwareDescription

public java.lang.String getServiceSoftwareDescription()

Get the service software description.

Returns:

the software description; null or empty string if none.

setServiceSoftwareDescription

public boolean setServiceSoftwareDescription(java.lang.String softwareDescription)

Set the service software description.

Parameters:

softwareDescription - holds the software description.

Returns:

whether the software description is set successfully or not.

getServiceAlgorithmDescription

public java.lang.String getServiceAlgorithmDescription()

Get the service algorithm description.

Returns:

the algorithm description; null or empty string if none.

setServiceAlgorithmDescription

public boolean setServiceAlgorithmDescription(java.lang.String algorithmDescription)

Set the algorithm description.

Parameters:

algorithmDescription - holds the algorithm description.

Returns:

whether the algorithm description is set successfully or not.

getServiceWebPage

public java.lang.String getServiceWebPage()

Get the service web page.

Returns:

the service web page; null or empty string if none.

setServiceWebPage

public boolean setServiceWebPage(java.lang.String webPage)

Set the service web page.

Parameters:

webPage - holds the service web page.

Returns:

whether the service web page is set successfully or not.

getServiceWSDLLocation

public java.lang.String getServiceWSDLLocation()

Get the service wsdl location.

Returns:

the service wsdl location; null or empty string if none.

setServiceWSDLLocation

public boolean setServiceWSDLLocation(java.lang.String wsdlLocation)

Set the service wsdl location.

Parameters:

wsdlLocation - holds the service wsdl location.

Returns:

whether the service wsdlLocation is set successfully or not.

getServiceLogoImageLink

public java.lang.String getServiceLogoImageLink()

Get the service logo image link.

Returns:

the service logo image link; null or empty string if none.

setServiceLogoImageLink

public boolean setServiceLogoImageLink(java.lang.String logoImageLink)

Set the service logo image link.

Parameters:

logoImageLink - holds the service logo image link.

Returns:

whether the service logoImageLink is set successfully or not.

getDefaultOptionNamesAndValues

public OSOption getDefaultOptionNamesAndValues()

Get the default option names and values in the standard OSOption structure which is specified by the OSoL schema.

Returns:

the default option names and values in the standard OSOption structure, null if none.

setDefaultOptionNamesAndValues

public boolean setDefaultOptionNamesAndValues(OSOption osOption)

Set the default option names and values in the standard OSOption structure which is specified by the OSoL schema.

Parameters:

osOption - holds the default option names and values in the standard OSOption structure.

Returns:

wehter the the default option names and values are set successfully or not.

getOptimizationDescription

public java.lang.String getOptimizationDescription()

Get the optimization description.

Returns:

the optimization description; null or empty string if none.

setOptimizationDescription

public boolean setOptimizationDescription(java.lang.String description)

Set the optimization description.

Parameters:

description - holds the optimization description.

Returns:

whether the optimization description is set successfully or not.

getOptimizationVariableType

public java.lang.String getOptimizationVariableType()

Get the optimization variable type, which can be: continuous, pureBinary, mixedBinary, pureInteger, mixedInteger, discrete.

Returns:

the optimization variable type; null or empty string if none.

setOptimizationVariableType

public boolean setOptimizationVariableType(java.lang.String variableType)

Set the optimization variable type.

Parameters:

variableType - holds the optimization variable type, which can be: continuous, pureBinary, mixedBinary, pureInteger, mixedInteger, discrete

Returns:

whether the optimization variable type is set successfully or not.

getOptimizationObjectiveType

public java.lang.String getOptimizationObjectiveType()

Get the optimization objective type, which can be: none, singleObjective, multiObjectives

Returns:

the optimization objective type; null or empty string if none.

setOptimizationObjectiveType

public boolean setOptimizationObjectiveType(java.lang.String objectiveType)

Set the optimization objective type.

Parameters:

objectiveType - holds the optimization objective type, which can be: none, singleObjective, multiObjectives

Returns:

whether the optimization objective type is set successfully or not.

getOptimizationConstraintType

public java.lang.String getOptimizationConstraintType()

Get the optimization constraint type, which can be: generalRange, pureEquality, pureBound, pureLinearComplementarity, pureNonlinearComplementarity, linearMixedComplementarity, nonlinearMixedComplementarity, generalMixedComplementarity, pureCone, mixedCone.

Returns:

the optimization constraint type; null or empty string if none.

setOptimizationConstraintType

public boolean setOptimizationConstraintType(java.lang.String constraintType)

Set the optimization constraint type.

Parameters:

constraintType - holds the optimization constraint type, which can be: generalRange, pureEquality, pureBound, pureLinearComplementarity, pureNonlinearComplementarity, linearMixedComplementarity, nonlinearMixedComplementarity, generalMixedComplementarity, pureCone, mixedCone.

Returns:

whether the optimization constraint type is set successfully or not.

getOptimizationObjectiveLinearity

public java.lang.String getOptimizationObjectiveLinearity()

Get the optimization objective linearity, which can be: none, linearNetwork, linear, sumOfSquares, convexQuadratic, convexNonlinear, generalQuadratic, generalNonlinear

Returns:

the optimization objective linearity; null or empty string if none.

setOptimizationObjectiveLinearity

public boolean setOptimizationObjectiveLinearity(java.lang.String objectiveLinearity)

Set the optimization objective linearity.

Parameters:

objectiveLinearity - holds the optimization objective linearity, which can be: none, linearNetwork, linear sumOfSquares, convexQuadratic, convexNonlinear, generalQuadratic, generalNonlinear

Returns:

whether the optimization objective linearity is set successfully or not.

getOptimizationConstraintLinearity

public java.lang.String getOptimizationConstraintLinearity()

Get the constraint objective linearity, which can be: none, bound, linearNetwork, linear, convexQuadratic, convexNonlinear, generalQuadratic, generalNonlinear

Returns:

the optimization constraint linearity; null or empty string if none.

setOptimizationConstraintLinearity

public boolean setOptimizationConstraintLinearity(java.lang.String constraintLinearity)

Set the optimization constraint linearity.

Parameters:

constraintLinearity - holds the optimization constraint linearity, which can be: none, bound, linearNetwork, linear, convexQuadratic, convexNonlinear, generalQuadratic, generalNonlinear

Returns:

whether the optimization constraint linearity is set successfully or not.

getOptimizationObjectiveDifferentiability

public java.lang.String getOptimizationObjectiveDifferentiability()

Get the optimization objective differentiability, which can be: generallyDifferentiable, twiceDifferentiable, firstDifferentiable, nonDifferentiableContinous, nonContinuous, simulation.

Returns:

the optimization objective differentiability; null or empty string if none.

setOptimizationObjectiveDifferentiability

public boolean setOptimizationObjectiveDifferentiability(java.lang.String objectiveDifferentiability)

Set the optimization objective differentiability.

Parameters:

objectiveDifferentiability - holds the optimization objective differentiability, which can be: generallyDifferentiable, twiceDifferentiable, firstDifferentiable, nonDifferentiableContinous, nonContinuous, simulation.

Returns:

whether the optimization objective differentiability is set successfully or not.

getOptimizationConstraintDifferentiability

public java.lang.String getOptimizationConstraintDifferentiability()

Get the optimization constraint differentiability, which can be: generallyDifferentiable, twiceDifferentiable, firstDifferentiable, nonDifferentiableContinous, nonContinuous, simulation.

Returns:

the optimization constraint differentiability; null or empty string if none.

setOptimizationConstraintDifferentiability

public boolean setOptimizationConstraintDifferentiability(java.lang.String constraintDifferentiability)

Set the optimization constraint differentiability.

Parameters:

constraintDifferentiability - holds the optimization constraint differentiability, which can be: generallyDifferentiable, twiceDifferentiable, firstDifferentiable, nonDifferentiableContinous, nonContinuous, simulation.

Returns:

whether the optimization constraint differentiability is set successfully or not.

getOptimizationParameterType

public java.lang.String getOptimizationParameterType()

Get the optimization parameter type, which can be: number, string, both

Returns:

the optimization parameter type; null or empty string if none.

setOptimizationParameterType

public boolean setOptimizationParameterType(java.lang.String parameterType)

Set the optimization parameter type.

Parameters:

parameterType - holds the optimization parameter type, which can be: number, string, both

Returns:

whether the optimization parameter type is set successfully or not.

getOptimizationStochasticity

public java.lang.String getOptimizationStochasticity()

Get the optimization stochasticity, which can be: deterministic, stochastic, both

Returns:

the optimization stochasticity; null or empty string if none.

setOptimizationStochasticity

public boolean setOptimizationStochasticity(java.lang.String stochasticity)

Set the optimization stochasticity.

Parameters:

tochasticity - holds the optimization stochasticity, which can be: deterministic, stochastic, both

Returns:

whether the optimization stochasticity is set successfully or not.

getOptimizationRealTime

public boolean getOptimizationRealTime()

Get whether the service supports real time optimization or not.

Returns:

whether the service supports real time optimization or not.

setOptimizationRealTime

public boolean setOptimizationRealTime(boolean realTime)

Set whether the service supports real time optimization or not.

Parameters:

realTime - holds whether the service supports real time optimization or not.

Returns:

whether the service supports real time optimization or not.

getOptimizationFunctionType

public FunctionType getOptimizationFunctionType()

Get the function types that the service supports.

Returns:

the function types that the service supports, null if none.

setOptimizationFunctionType

public boolean setOptimizationFunctionType(FunctionType functionType)

Set the function types that the service supports.

Parameters:

functionType - holds the function types that the service supports.

Returns:

the function types that the service supports.

getOptimizationSpecialStructure

public SpecialStructure getOptimizationSpecialStructure()

Get the special structures that the service supports.

Returns:

the special structures that the service supports, null if none.

setOptimizationSpecialStructure

public boolean setOptimizationSpecialStructure(SpecialStructure specialStructure)

Set the special structures that the service supports.

Parameters:

specialStructure - holds the special structures that the service supports.

Returns:

the special structures that the service supports.

getOptimizationSpecialAlgorithm

public SpecialAlgorithm getOptimizationSpecialAlgorithm()

Get the special algorithms that the service supports.

Returns:

the special algorithms that the service supports, null if none.

setOptimizationSpecialAlgorithm

public boolean setOptimizationSpecialAlgorithm(SpecialAlgorithm specialAlgorithm)

Set the special algorithms that the service supports.

Parameters:

specialAlgorithm - holds the special algorithms that the service supports.

Returns:

the special algorithms that the service supports.

getOtherEntityInfoNames

public java.lang.String[] getOtherEntityInfoNames()

get a string array of names of other entity info.

Returns:

a string array of names of other entity info, null if no other entity info.

getOtherEntityInfoDescriptions

public java.util.Hashtable<java.lang.String,java.lang.String> getOtherEntityInfoDescriptions()

get a hashmap of other entity info descriptions. The keys of the hashmap are the entity info names, and the values of the hashmap are the entity info descriptions.

Returns:

a hashmap of other entity info descriptions, null if no other entity info.

getOtherEntityInfoValues

public java.util.Hashtable<java.lang.String,java.lang.String> getOtherEntityInfoValues()

get a hashmap of other entity info values. The keys of the hashmap are the entity info names, and the values of the hashmap are the entity info values.

Returns:

a hashmap of other entity info values, null if no other entity info.

setOtherEntityInfo

public boolean setOtherEntityInfo(java.lang.String[] names,
                                  java.lang.String[] descriptions,
                                  java.lang.String[] values)

set other entity info, with their names (required), descriptions (optional) and values (optional).

Parameters:

names - holds the names of the other entity info; it is required.

descriptions - holds the descriptions of the other entity info; null if none.

values - holds the values of the other entity info; null if none.

Returns:

whether the other anlysis information is set successfully.

main

public static void main(java.lang.String[] args)

main for test purposes.

Parameters:

argv - command line arguments.