A B C D E F G H I L M N P Q R S T U V W X Y

A

addOtherAttribute(String, String) - Method in class esa.opensf.osfi.Parameter

Set an the value of a non-standard parameter attribute.

ArrayNode<V,S extends ArrayNode<V,S>> - Class in esa.opensf.osfi

Class that represents a tree with data (leaf) nodes and internal nodes.

ArrayNode(V) - Constructor for class esa.opensf.osfi.ArrayNode

Create a data node with the given contents.

ArrayNode(List<? extends S>) - Constructor for class esa.opensf.osfi.ArrayNode

Create an internal node with the given subnodes.

ArrayNode.Parsed<A> - Class in esa.opensf.osfi

A parsed tree that represents the values of (part of) an ARRAY-valued parameter.

ArrayNode.Raw - Class in esa.opensf.osfi

An unparsed tree that represents (part of) an ARRAY-valued parameter.

B

Builder(Class<E>, int, int, List<LoadResult.Event>) - Constructor for class esa.opensf.osfi.LoadResult.Builder

Create a helper that processes events and may generate a LoadResult.

C

checkValidFile(String) - Method in class esa.opensf.osfi.CLP

Deprecated.

It validates a file according to CLI v1

CLP - Class in esa.opensf.osfi

Provides procedures to parse the command line arguments, generating a list of tokens grouped as: Configuration files Input files Output files The command line could follow one of the two versions supported.

CLP(String[]) - Constructor for class esa.opensf.osfi.CLP

Parse the command line arguments into the configuration, input and output files.

compareTo(TimeValue) - Method in class esa.opensf.osfi.TimeValue

Values are compared field by field from most to least significant.

D

data - Variable in class esa.opensf.osfi.LoadResult.Event

Recorded data.

dataEquals(ArrayNode<?, ?>) - Method in class esa.opensf.osfi.ArrayNode

Comparison of data values.

dataEquals(ArrayNode<?, ?>) - Method in class esa.opensf.osfi.ArrayNode.Raw

dataHashCode() - Method in class esa.opensf.osfi.ArrayNode

dataHashCode() - Method in class esa.opensf.osfi.ArrayNode.Raw

dataToStr() - Method in class esa.opensf.osfi.ArrayNode

dataToStr() - Method in class esa.opensf.osfi.ArrayNode.Parsed

dataToStr() - Method in class esa.opensf.osfi.ArrayNode.Raw

debug(String) - Static method in class esa.opensf.osfi.Logger

Shows a formatted debug message, if the environment variable "DEBUG_MODE" is equal to "On".

dom - Variable in class esa.opensf.osfi.TimeValue

Day of month, 1 to 28/29/30/31 depending on the month/year combination.

DomUtils - Class in esa.opensf.osfi.xmlutils

Utility class with methods that work on DOM nodes, documents and elements.

E

elems - Variable in class esa.opensf.osfi.ArrayNode

Elements for a data node.

equals(Object) - Method in class esa.opensf.osfi.ArrayNode

equals(Object) - Method in class esa.opensf.osfi.TimeValue

Returns true if the other object compares equal to this, that is, if it is also of type TimeValue and all its fields match those of this.

error(String) - Static method in class esa.opensf.osfi.Logger

Shows a formatted error message.

esa.opensf.osfi - package esa.opensf.osfi

OSFI is a multilanguage library that provides utilities for building modules compliant with the Generic E2E Simulator ICD from ESA.

esa.opensf.osfi.xmlutils - package esa.opensf.osfi.xmlutils

Package with helper functions and classes to read and manipulate XML files and DOM trees.

Event(int, Exception, String) - Constructor for class esa.opensf.osfi.LoadResult.Event

events - Variable in class esa.opensf.osfi.LoadResult.Builder

Warnings and errors recorded during processing.

existParameter(String) - Method in class esa.opensf.osfi.ParamReader

Checks the existence of a parameter within a configuration file.

EXTATTR_PATHSEP - Static variable in class esa.opensf.osfi.ParamParserComplex

Separator for the names of extra attributes which include the path of a sub-element.

F

fileExist() - Method in class esa.opensf.osfi.Parameter

Checks the existence of the files specified within a FILE parameter. For a scalar, the returned value is a 1x1 matrix, with the result in item [0][0].

finishEmpty(Object, Exception) - Method in class esa.opensf.osfi.LoadResult.Builder

Complete the operation without a result object.

finishExecution(int) - Static method in class esa.opensf.osfi.Logger

Shows an information message and exits the program execution with an specific error code.

finishWithResult(Object, R) - Method in class esa.opensf.osfi.LoadResult.Builder

Complete the operation with a result object.

formatEventData(int, E) - Method in class esa.opensf.osfi.LoadResult.Builder

Custom formatter for an event to appear in the OSFI log.

G

getAllParameters() - Method in class esa.opensf.osfi.ParamReader

getBooleanValue() - Method in class esa.opensf.osfi.Parameter

getChildElements(Node, String) - Static method in class esa.opensf.osfi.XMLParser

Deprecated.

Given a DOM Node, returns all the direct children elements with the given name.

getChildElements(Node, String) - Static method in class esa.opensf.osfi.xmlutils.DomUtils

getComplexType() - Method in class esa.opensf.osfi.Parameter

getComplexType() - Method in class esa.opensf.osfi.ParamParserComplex

getConfFile() - Method in class esa.opensf.osfi.CLP

Deprecated.

Modules that do not support a global configuration file are deprecated

getConfFiles() - Method in class esa.opensf.osfi.CLP

getData() - Method in class esa.opensf.osfi.ArrayNode

getDataAtSub(int...) - Method in class esa.opensf.osfi.ArrayNode

Equivalent to getSubNodeAt(indices).getData(), except that if indices is empty, this this method returns the result of calling ArrayNode.getData() on this instead of throwing.

getDataDim() - Method in class esa.opensf.osfi.ArrayNode

getDataDim() - Method in class esa.opensf.osfi.ArrayNode.Parsed

getDataDim() - Method in class esa.opensf.osfi.ArrayNode.Raw

getDescription() - Method in class esa.opensf.osfi.Parameter

getDim() - Method in class esa.opensf.osfi.ArrayNode

getDims() - Method in class esa.opensf.osfi.Parameter

Returns the envelope of the parameter dimensions.

getDimsEnvelope() - Method in class esa.opensf.osfi.ArrayNode

Compute the rectangular envelope for the dimensions of this array node, considering all nodes below it in the tree.

getDoubleValue() - Method in class esa.opensf.osfi.Parameter

getElementType() - Method in class esa.opensf.osfi.Parameter

getExtraAttrs() - Method in class esa.opensf.osfi.ParamParserComplex

getFileFormattedValue(String) - Static method in class esa.opensf.osfi.Parameter

Ensures that the argument does not contain invalid characters for a path.

getFileValue() - Method in class esa.opensf.osfi.Parameter

getInputFiles() - Method in class esa.opensf.osfi.CLP

getIntValue() - Method in class esa.opensf.osfi.Parameter

getListDims() - Method in class esa.opensf.osfi.ParamParserComplex

getLocalName() - Method in class esa.opensf.osfi.Parameter

getMatrixBoolean() - Method in class esa.opensf.osfi.Parameter

getMatrixDouble() - Method in class esa.opensf.osfi.Parameter

getMatrixFile() - Method in class esa.opensf.osfi.Parameter

getMatrixInt() - Method in class esa.opensf.osfi.Parameter

getMatrixString() - Method in class esa.opensf.osfi.Parameter

getMatrixTime() - Method in class esa.opensf.osfi.Parameter

getMatrixValue() - Method in class esa.opensf.osfi.ParamParserComplex

getMax() - Method in class esa.opensf.osfi.Parameter

getMin() - Method in class esa.opensf.osfi.Parameter

getName() - Method in class esa.opensf.osfi.Parameter

Deprecated.

Ambiguous function, instead use Parameter.getLocalName() or Parameter.getPath().

getNdims() - Method in class esa.opensf.osfi.Parameter

getOtherAttribute(String) - Method in class esa.opensf.osfi.Parameter

getOtherAttributes() - Method in class esa.opensf.osfi.Parameter

getOutputFiles() - Method in class esa.opensf.osfi.CLP

getParameter(String) - Method in class esa.opensf.osfi.ParamReader

Retrieves the parameter object corresponding with given name in the configuration file.

getParameters(String) - Method in class esa.opensf.osfi.ParamReader

getPath() - Method in class esa.opensf.osfi.Parameter

getRawValue() - Method in class esa.opensf.osfi.Parameter

getRootNode() - Method in class esa.opensf.osfi.Parameter

Specific method for Array types.

getRootNode() - Method in class esa.opensf.osfi.ParamParserComplex

getStringValue() - Method in class esa.opensf.osfi.Parameter

getSubNodeAt(int...) - Method in class esa.opensf.osfi.ArrayNode

Equivalent to calling s = s.getSubNodes().get(i) for each index given, starting with this object.

getSubNodes() - Method in class esa.opensf.osfi.ArrayNode

getTimeValue() - Method in class esa.opensf.osfi.Parameter

getTreeBoolean() - Method in class esa.opensf.osfi.ArrayNode.Raw

getTreeDouble() - Method in class esa.opensf.osfi.ArrayNode.Raw

getTreeFile() - Method in class esa.opensf.osfi.ArrayNode.Raw

getTreeInt() - Method in class esa.opensf.osfi.ArrayNode.Raw

getTreeString() - Method in class esa.opensf.osfi.ArrayNode.Raw

getTreeTime() - Method in class esa.opensf.osfi.ArrayNode.Raw

getType() - Method in class esa.opensf.osfi.Parameter

Gets the element data type of the parameter, as a string.

getType() - Method in class esa.opensf.osfi.ParamParserComplex

getUnits() - Method in class esa.opensf.osfi.Parameter

getUsage() - Method in class esa.opensf.osfi.UsageReader

getValue() - Method in class esa.opensf.osfi.Parameter

Deprecated.

Ambiguously-named function to be removed, use Parameter.getRawValue() instead.

getVectorBoolean(boolean) - Method in class esa.opensf.osfi.ArrayNode.Raw

getVectorBoolean() - Method in class esa.opensf.osfi.Parameter

getVectorDouble(boolean) - Method in class esa.opensf.osfi.ArrayNode.Raw

getVectorDouble() - Method in class esa.opensf.osfi.Parameter

getVectorFile(boolean) - Method in class esa.opensf.osfi.ArrayNode.Raw

getVectorFile() - Method in class esa.opensf.osfi.Parameter

getVectorInt(boolean) - Method in class esa.opensf.osfi.ArrayNode.Raw

getVectorInt() - Method in class esa.opensf.osfi.Parameter

getVectorString(boolean) - Method in class esa.opensf.osfi.ArrayNode.Raw

getVectorString() - Method in class esa.opensf.osfi.Parameter

getVectorTime(boolean) - Method in class esa.opensf.osfi.ArrayNode.Raw

getVectorTime() - Method in class esa.opensf.osfi.Parameter

H

hasEvents(int) - Method in class esa.opensf.osfi.LoadResult

hashCode() - Method in class esa.opensf.osfi.ArrayNode

hashCode() - Method in class esa.opensf.osfi.TimeValue

Returns a hash code composed of all the fields in the instance.

hour - Variable in class esa.opensf.osfi.TimeValue

Hour, 0 to 23.

I

info(String) - Static method in class esa.opensf.osfi.Logger

Shows a formatted information message.

isArray() - Method in class esa.opensf.osfi.Parameter

isColored() - Static method in class esa.opensf.osfi.Logger

OSFI writes log banners in colour if the OSFI_LOG_COLOR environment variable is set to .

isDataNode() - Method in class esa.opensf.osfi.ArrayNode

isDebugging() - Static method in class esa.opensf.osfi.Logger

OSFI only writes messages with the "Debug" category to the actual log if the DEBUG_MODE environment variable is set to .

isStandardAttribute(String) - Static method in class esa.opensf.osfi.ParamReader

Determines whether a given parameter attribute is E2E-ICD standard.

isStringBased() - Method in enum esa.opensf.osfi.Parameter.ParamType

L

load(LoadResult<Document>, boolean, Map<String, Parameter>, Set<ParamReader.WarningType>) - Static method in class esa.opensf.osfi.ParamReader

Parse the contents of an XML document into OSFI parameters.

load(LoadResult<Document>, boolean, Map<String, Parameter>) - Static method in class esa.opensf.osfi.ParamReader

Parse the contents of an XML document into OSFI parameters.

load(LoadResult<Document>, boolean) - Static method in class esa.opensf.osfi.ParamReader

Parse the contents of an XML document into OSFI parameters.

load(File) - Static method in class esa.opensf.osfi.xmlutils.XmlFiles

Read and parse a XML document, without validation.

load(File, boolean) - Static method in class esa.opensf.osfi.xmlutils.XmlFiles

Read and parse a XML document, without validation.

loadAndValidate(File, File, String, boolean) - Static method in class esa.opensf.osfi.xmlutils.XmlFiles

Read and parse a XML document, validating against an internal or external schema.

loadEvents - Variable in class esa.opensf.osfi.LoadResult

Events recorded during the process.

LoadResult<R> - Class in esa.opensf.osfi

Immutable type that represents the result of a "load" operation, either from ParamReader loading some configuration file, or raw parsing/validation of an XML file.

LoadResult.Builder<E extends java.lang.Exception> - Class in esa.opensf.osfi

Helper that processes events during a load operation to generate a LoadResult.

LoadResult.Event - Class in esa.opensf.osfi

"Event" raised during a load operation (of parameters, of an XML file, etc).

Logger - Class in esa.opensf.osfi

Logger.

M

message - Variable in class esa.opensf.osfi.LoadResult.Event

Human-readable version of LoadResult.Event.data, never null.

minute - Variable in class esa.opensf.osfi.TimeValue

Minute, 0 to 59.

month - Variable in class esa.opensf.osfi.TimeValue

Month, 1 to 12.

N

nanosec - Variable in class esa.opensf.osfi.TimeValue

Fraction of the second in nanosecond precision, 0 to 999_999_999.

P

Parameter - Class in esa.opensf.osfi

Parameter.

Parameter(String, String, String, String) - Constructor for class esa.opensf.osfi.Parameter

Constructor for scalar values.

Parameter(String, String, Parameter.ParamType, Parameter.ParamComplexType, String, String, String, String, List<Integer>) - Constructor for class esa.opensf.osfi.Parameter

Constructor for non-array parameters.

Parameter(String, String, Parameter.ParamType, Parameter.ParamComplexType, ArrayNode.Raw, String, String, String, List<Integer>) - Constructor for class esa.opensf.osfi.Parameter

Constructor for ARRAY parameters.

Parameter.ParamComplexType - Enum in esa.opensf.osfi

Represents the type of a structured parameter.

Parameter.ParamType - Enum in esa.opensf.osfi

Represents the element type of a Parameter object.

ParamParserComplex - Class in esa.opensf.osfi

Helper class used by ParamReader to process the values of structured parameters.

ParamParserComplex(Element, String) - Constructor for class esa.opensf.osfi.ParamParserComplex

Parse the data in the given XML element, which represents a parameter with a structured type.

ParamReader - Class in esa.opensf.osfi

ParamReader.

ParamReader(String, String) - Constructor for class esa.opensf.osfi.ParamReader

Deprecated.

Use the single argument version and call ParamReader.validateAgainst(String)

ParamReader(String) - Constructor for class esa.opensf.osfi.ParamReader

Parses a given configuration XML file and stores the parameters read from it.

ParamReader(Element, String) - Constructor for class esa.opensf.osfi.ParamReader

Parses a given configuration XML subtree and stores the parameters read from it.

ParamReader.WarningType - Enum in esa.opensf.osfi

Enum to represent different categories of warnings.

parse(String) - Static method in class esa.opensf.osfi.TimeValue

Parse the value of (a single element of) a TIME parameter, which must be in CCSDS ASCII calendar segmented time code format.

Parsed(A, Function<A, String>) - Constructor for class esa.opensf.osfi.ArrayNode.Parsed

Data node constructor.

Parsed(List<ArrayNode.Parsed<A>>) - Constructor for class esa.opensf.osfi.ArrayNode.Parsed

ParseException(String, String, Exception) - Constructor for exception esa.opensf.osfi.XMLParser.ParseException

Deprecated.

parseFiles(String) - Method in class esa.opensf.osfi.CLP

Deprecated.

The method is not part of the external API. It only makes sense for CLI v1.

printMessage(String, String, String, String) - Static method in class esa.opensf.osfi.Logger

Deprecated.

Internal function, to be removed from public API

processEvent(int, E) - Method in class esa.opensf.osfi.LoadResult.Builder

Method called by subclasses to ingest an event.

progress(int, int) - Static method in class esa.opensf.osfi.Logger

Shows a formatted progress message.

Q

qualityReport(String, double) - Static method in class esa.opensf.osfi.Logger

Shows a formatted message reporting a quality indicator.

qualityReport(String, String) - Static method in class esa.opensf.osfi.Logger

Shows a formatted message reporting a quality indicator.

R

Raw(int, String) - Constructor for class esa.opensf.osfi.ArrayNode.Raw

Data node constructor.

Raw(List<ArrayNode.Raw>) - Constructor for class esa.opensf.osfi.ArrayNode.Raw

read(String, String) - Static method in class esa.opensf.osfi.XMLParser

Deprecated.

Due to the convoluted behaviour (to validate against internal schema a non-null but blank file has to be passed).

read(String) - Static method in class esa.opensf.osfi.XMLParser

Deprecated.

Read and parse a XML document, without validation.

result - Variable in class esa.opensf.osfi.LoadResult

Result of the load operation.

S

sec - Variable in class esa.opensf.osfi.TimeValue

Second, 0 to 60 (to allow for leap seconds, which are not verified).

setParameter(String, Parameter) - Method in class esa.opensf.osfi.ParamReader

Changes the stored value of a certain parameter.

setValue(String) - Method in class esa.opensf.osfi.Parameter

Sets the parameter unparsed (raw) value.

SEV_ERROR - Static variable in class esa.opensf.osfi.LoadResult

Partially recoverable problems with the data source that imply a certain loss of data but which do not prevent further processing.

SEV_FATAL - Static variable in class esa.opensf.osfi.LoadResult

Unrecoverable problems with the data source that stop all processing.

SEV_INFO - Static variable in class esa.opensf.osfi.LoadResult

General reports that do not represent any problem with the data source.

SEV_WARNING - Static variable in class esa.opensf.osfi.LoadResult

Recoverable issues with the data source e.g.

severity - Variable in class esa.opensf.osfi.LoadResult.Event

Category of the event.

source - Variable in class esa.opensf.osfi.LoadResult

Data source for the operation, e.g.

T

TimeValue - Class in esa.opensf.osfi

Class that represents the parsed value of a TIME-formatted parameter.

TimeValue(int, int, int, int, int, int, int) - Constructor for class esa.opensf.osfi.TimeValue

Create an instance representing the given point in time.

toString() - Method in class esa.opensf.osfi.ArrayNode

toString() - Method in class esa.opensf.osfi.TimeValue

U

unwrap(int) - Method in class esa.opensf.osfi.LoadResult

If no events at or above the given severity level exist, return LoadResult.result.

unwrap() - Method in class esa.opensf.osfi.LoadResult

Equivalent to calling LoadResult.unwrap(int) with LoadResult.SEV_ERROR.

UsageReader - Class in esa.opensf.osfi

UsageReader.

UsageReader(String) - Constructor for class esa.opensf.osfi.UsageReader

Class constructor.

V

validate(File, File, String, boolean) - Static method in class esa.opensf.osfi.xmlutils.XmlFiles

Validates an XML file against a schema.

validateAgainst(String) - Method in class esa.opensf.osfi.ParamReader

Validate the XML file read against the given XSD schema.

validateAgainst(Node, String) - Static method in class esa.opensf.osfi.XMLParser

Deprecated.

Validate a document/element tree against an external XSD file.

validateAgainst(Node, String) - Static method in class esa.opensf.osfi.xmlutils.DomUtils

Validate a document/element tree against an external XSD file.

validateAgainstInternalSchema() - Method in class esa.opensf.osfi.ParamReader

Validate the XML file read against the XSD schema referenced in the file itself.

validateAgainstInternalSchema(Node) - Static method in class esa.opensf.osfi.XMLParser

Deprecated.

Validate a document/element tree against a XSD schema referenced in the XML itself.

validateAgainstInternalSchema(Node) - Static method in class esa.opensf.osfi.xmlutils.DomUtils

Validate a document/element tree against a XSD schema referenced in the XML itself.

valueOf(String) - Static method in enum esa.opensf.osfi.Parameter.ParamComplexType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum esa.opensf.osfi.Parameter.ParamType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum esa.opensf.osfi.ParamReader.WarningType

Returns the enum constant of this type with the specified name.

values() - Static method in enum esa.opensf.osfi.Parameter.ParamComplexType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum esa.opensf.osfi.Parameter.ParamType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum esa.opensf.osfi.ParamReader.WarningType

Returns an array containing the constants of this enum type, in the order they are declared.

W

W3C_NS_URI_XSD10 - Static variable in class esa.opensf.osfi.xmlutils.XmlFiles

Default version of the XSD standard; Java 8 states that at least XSD 1.0 is supported.

W3C_NS_URI_XSD11 - Static variable in class esa.opensf.osfi.xmlutils.XmlFiles

XSD standard version 1.1 (specifically).

warning(String) - Static method in class esa.opensf.osfi.Logger

Shows a formatted warning message.

write() - Method in class esa.opensf.osfi.Parameter

Prints a textual description of the parameter to the OSFI log as an Info message.

write() - Method in class esa.opensf.osfi.ParamReader

Prints a textual representation of the list of Parameters on screen.

X

XmlFiles - Class in esa.opensf.osfi.xmlutils

XmlParseException - Exception in esa.opensf.osfi.xmlutils

Type of exception thrown by methods in XmlFiles and DomUtils.

XmlParseException(String, String, Exception) - Constructor for exception esa.opensf.osfi.xmlutils.XmlParseException

Reports a message from the given source file, with a message and causing exception.

XMLParser - Class in esa.opensf.osfi

Deprecated.

This class has been moved to XmlFiles and DomUtils to reduce clutter

XMLParser.ParseException - Exception in esa.opensf.osfi

Deprecated.

This class has been "renamed" XmlParseException to reduce namespace clutter

Y

year - Variable in class esa.opensf.osfi.TimeValue

Year number, 1 to 9999.

A B C D E F G H I L M N P Q R S T U V W X Y