public class DescriptorValue extends Object implements Serializable
Constructor and Description |
---|
DescriptorValue(DescriptorSpecification specification,
String[] parameterNames,
Object[] parameterSettings,
IDescriptorResult value,
String[] descriptorNames)
Construct a descriptor value object, representing the numeric values as well as parameters and provenance.
|
DescriptorValue(DescriptorSpecification specification,
String[] parameterNames,
Object[] parameterSettings,
IDescriptorResult value,
String[] descriptorNames,
Exception exception)
Construct a descriptor value object, representing the numeric values as well as parameters and provenance.
|
Modifier and Type | Method and Description |
---|---|
Exception |
getException() |
String[] |
getNames()
Returns an array of names for each descriptor value calculated.
|
String[] |
getParameterNames() |
Object[] |
getParameters() |
DescriptorSpecification |
getSpecification() |
IDescriptorResult |
getValue() |
public DescriptorValue(DescriptorSpecification specification, String[] parameterNames, Object[] parameterSettings, IDescriptorResult value, String[] descriptorNames)
specification
- The specificationparameterNames
- The parameter names for the descriptorsparameterSettings
- The parameter settingsvalue
- The actual valuesdescriptorNames
- The names of the valuespublic DescriptorValue(DescriptorSpecification specification, String[] parameterNames, Object[] parameterSettings, IDescriptorResult value, String[] descriptorNames, Exception exception)
specification
- The specificationparameterNames
- The parameter names for the descriptorsparameterSettings
- The parameter settingsvalue
- The actual valuesdescriptorNames
- The names of the valuesexception
- The exception object that should have been caught if an error occurred during descriptor
calculationpublic DescriptorSpecification getSpecification()
public Object[] getParameters()
public String[] getParameterNames()
public IDescriptorResult getValue()
public Exception getException()
public String[] getNames()
DescriptorValue
object, it should supply an array of names equal
in length to the number of descriptor calculated.
In many cases, these names can be as simple as X0, X1, ..., XN where X is a prefix
and 0, 1, ..., N are the indices. On the other hand it is also possible to return
other arbitrary names, which should be documented in the JavaDocs for the descriptor
(e.g., the CPSA descriptor).
Note that by default if a descriptor returns a single value (such as ALOGPDescriptor
the return array will have a single element
In case a descriptor creates a DescriptorValue
object with no names, this
method will generate a set of names based on the DescriptorSpecification
object
supplied at instantiation.Copyright © 2021. All rights reserved.