OSFI-Java  3.9.2
OpenSF Integration Library
Deprecated List
Member esa.opensf.osfi.CLP.checkValidFile (final String file)
It validates a file according to CLI v1
Member esa.opensf.osfi.CLP.getConfFile ()
Modules that do not support a global configuration file are deprecated
Member esa.opensf.osfi.CLP.parseFiles (final String arg)
The method is not part of the external API. It only makes sense for CLI v1.
Member esa.opensf.osfi.Logger.printMessage (String logType, String message, String fg, String bg)
Internal function, to be removed from public API
Member esa.opensf.osfi.Parameter.getName ()
Ambiguous function, instead use getLocalName or getPath
Member esa.opensf.osfi.Parameter.getValue ()
Ambiguously-named function to be removed, use getRawValue() instead.
Member esa.opensf.osfi.ParamReader.ParamReader (final String xmlFile, final String xsdFile)
Use the single argument version and call validateAgainst(String)
Class esa.opensf.osfi.XMLParser
This class has been moved to XmlFiles and DomUtils to reduce clutter
Member esa.opensf.osfi.XMLParser.read (String xmlFile, String xsdFile)
Due to the convoluted behaviour (to validate against internal schema a non-null but blank file has to be passed).
esa.opensf.osfi.ParamReader.setParameter
void setParameter(String paramName, Parameter value)
Definition: ParamReader.java:285
esa.opensf.osfi.ParamReader.ParamReader
ParamReader(String xmlFile)
Definition: ParamReader.java:110
esa.opensf.osfi.Parameter.ParamComplexType.MATRIX
MATRIX
Definition: Parameter.java:55
esa.opensf.osfi.Parameter.getValue
String getValue()
Definition: Parameter.java:146
esa.opensf.osfi.CLP.getOutputFiles
List< String > getOutputFiles()
Definition: CLP.java:269
esa.opensf.osfi.Parameter.getVectorTime
TimeValue[] getVectorTime()
Definition: Parameter.java:258
esa.opensf.osfi.Parameter.getVectorDouble
double[] getVectorDouble()
Definition: Parameter.java:244
esa.opensf.osfi.xmlutils.XmlFiles
Definition: XmlFiles.java:34
esa.opensf.osfi.Parameter.getTimeValue
TimeValue getTimeValue()
Definition: Parameter.java:198
esa.opensf.osfi.xmlutils.XmlFiles.load
static LoadResult< Document > load(final File file)
Definition: XmlFiles.java:74
esa.opensf.osfi.Parameter.getIntValue
int getIntValue()
Definition: Parameter.java:174
esa.opensf.osfi.Parameter.getDescription
String getDescription()
Definition: Parameter.java:527
esa.opensf.osfi.ArrayNode.dataEquals
boolean dataEquals(ArrayNode<?, ?> other)
Definition: ArrayNode.java:143
esa.opensf.osfi.Parameter.ParamType.isStringBased
final boolean isStringBased()
Definition: Parameter.java:40
esa.opensf.osfi.ArrayNode.dataToStr
abstract String dataToStr()
esa.opensf.osfi.Parameter.getMatrixFile
String[][] getMatrixFile()
Definition: Parameter.java:355
esa.opensf.osfi.TimeValue.sec
final byte sec
Definition: TimeValue.java:45
esa.opensf.osfi.CLP.parseFiles
List< String > parseFiles(final String arg)
Definition: CLP.java:196
esa.opensf.osfi.LoadResult.unwrap
R unwrap(final int minThrowSeverity)
Definition: LoadResult.java:93
esa.opensf.osfi.LoadResult.source
final String source
Definition: LoadResult.java:68
esa.opensf.osfi.TimeValue.year
final short year
Definition: TimeValue.java:35
esa.opensf.osfi.Parameter.getLocalName
String getLocalName()
Definition: Parameter.java:511
esa.opensf.osfi.ParamReader.ParamReader
ParamReader(Element el, String pathPrefix)
Definition: ParamReader.java:123
esa.opensf.osfi.Logger.finishExecution
static void finishExecution(int errorCode)
Definition: Logger.java:130
esa.opensf.osfi.XMLParser.read
static Document read(String xmlFile, String xsdFile)
Definition: XMLParser.java:55
esa.opensf.osfi.LoadResult.hasEvents
boolean hasEvents(int minSeverity)
Definition: LoadResult.java:83
esa.opensf.osfi.ArrayNode.getDataDim
abstract int getDataDim()
esa.opensf.osfi.ArrayNode.ArrayNode
ArrayNode(List<? extends S > subNodes)
Definition: ArrayNode.java:38
esa.opensf.osfi.ArrayNode.getSubNodeAt
final S getSubNodeAt(final int... indices)
Definition: ArrayNode.java:67
esa.opensf.osfi.xmlutils.XmlFiles.loadAndValidate
static LoadResult< Document > loadAndValidate(final File file, final File schema, final String schemaLang, final boolean stopOnFirstError)
Definition: XmlFiles.java:107
esa.opensf.osfi.TimeValue.hashCode
int hashCode()
Definition: TimeValue.java:134
esa.opensf.osfi.TimeValue.compareTo
int compareTo(final TimeValue o)
Definition: TimeValue.java:97
esa.opensf.osfi.xmlutils.XmlFiles.load
static LoadResult< Document > load(final File file, final boolean stopOnFirstError)
Definition: XmlFiles.java:88
esa.opensf.osfi.Logger.debug
static void debug(String message)
Definition: Logger.java:103
esa.opensf.osfi.Parameter.getComplexType
String getComplexType()
Definition: Parameter.java:575
esa.opensf.osfi.XMLParser.validateAgainstInternalSchema
static boolean validateAgainstInternalSchema(final Node docOrEl)
Definition: XMLParser.java:89
esa.opensf.osfi.LoadResult.SEV_FATAL
static final int SEV_FATAL
Definition: LoadResult.java:49
esa.opensf.osfi.Parameter.write
void write()
Definition: Parameter.java:111
esa.opensf.osfi.Parameter.getDims
List< Integer > getDims()
Definition: Parameter.java:492
esa.opensf.osfi.xmlutils.XmlFiles.W3C_NS_URI_XSD11
static final String W3C_NS_URI_XSD11
Definition: XmlFiles.java:39
esa.opensf.osfi.CLP
Definition: CLP.java:80
esa.opensf.osfi.Parameter.getVectorFile
String[] getVectorFile()
Definition: Parameter.java:272
esa.opensf.osfi.Parameter.ParamComplexType
Definition: Parameter.java:53
esa.opensf.osfi.ArrayNode.getSubNodes
final List< S > getSubNodes()
Definition: ArrayNode.java:55
esa.opensf.osfi.ParamReader.load
static LoadResult< ParamReader > load(final LoadResult< Document > xml, final boolean stopOnSingleParamError, final Map< String, Parameter > map)
Definition: ParamReader.java:185
esa.opensf.osfi.UsageReader.getUsage
String getUsage()
Definition: UsageReader.java:58
esa.opensf.osfi.LoadResult.result
final R result
Definition: LoadResult.java:70
esa.opensf.osfi.Parameter.isArray
boolean isArray()
Definition: Parameter.java:136
esa.opensf.osfi.CLP.checkValidFile
void checkValidFile(final String file)
Definition: CLP.java:236
esa.opensf.osfi.UsageReader.UsageReader
UsageReader(String xmlFile)
Definition: UsageReader.java:38
esa.opensf.osfi.CLP.getConfFile
String getConfFile()
Definition: CLP.java:246
esa.opensf.osfi.Parameter.getElementType
ParamType getElementType()
Definition: Parameter.java:566
esa.opensf.osfi.CLP.CLP
CLP(final String[] args)
Definition: CLP.java:103
esa.opensf.osfi.CLP.getInputFiles
List< String > getInputFiles()
Definition: CLP.java:262
esa.opensf.osfi.Parameter.getMatrixBoolean
boolean[][] getMatrixBoolean()
Definition: Parameter.java:331
esa.opensf.osfi.Logger.qualityReport
static void qualityReport(String name, double value)
Definition: Logger.java:140
esa.opensf.osfi.Parameter.getVectorBoolean
boolean[] getVectorBoolean()
Definition: Parameter.java:251
esa.opensf.osfi.ArrayNode.dataHashCode
int dataHashCode()
Definition: ArrayNode.java:151
esa.opensf.osfi.Logger.progress
static void progress(int step, int nSteps)
Definition: Logger.java:114
esa.opensf.osfi.Parameter.getMatrixTime
TimeValue[][] getMatrixTime()
Definition: Parameter.java:339
esa.opensf.osfi.XMLParser.validateAgainst
static boolean validateAgainst(final Node docOrEl, final String xsdFile)
Definition: XMLParser.java:83
esa.opensf.osfi.ArrayNode.ArrayNode
ArrayNode(V values)
Definition: ArrayNode.java:33
esa.opensf.osfi.ArrayNode.toString
String toString()
Definition: ArrayNode.java:126
esa.opensf.osfi.LoadResult.SEV_ERROR
static final int SEV_ERROR
Definition: LoadResult.java:43
esa.opensf.osfi.Parameter.getPath
String getPath()
Definition: Parameter.java:519
esa.opensf.osfi.CLP.getConfFiles
List< String > getConfFiles()
Definition: CLP.java:255
esa.opensf.osfi.Parameter.getName
String getName()
Definition: Parameter.java:503
esa.opensf.osfi.ArrayNode.isDataNode
final boolean isDataNode()
Definition: ArrayNode.java:44
esa.opensf.osfi.Parameter.setValue
void setValue(final String value)
Definition: Parameter.java:473
esa.opensf.osfi.ParamReader.getParameter
Parameter getParameter(String name)
Definition: ParamReader.java:246
esa.opensf.osfi.ArrayNode.elems
final V elems
Definition: ArrayNode.java:29
esa.opensf.osfi.Parameter.getRootNode
ArrayNode.Raw getRootNode()
Definition: Parameter.java:365
esa.opensf.osfi.Parameter.getFileFormattedValue
static String getFileFormattedValue(String fileName)
Definition: Parameter.java:428
esa.opensf.osfi.Parameter.getMatrixString
String[][] getMatrixString()
Definition: Parameter.java:347
esa.opensf.osfi.ParamReader.existParameter
boolean existParameter(String name)
Definition: ParamReader.java:274
esa.opensf.osfi.ArrayNode.getDim
final int getDim()
Definition: ArrayNode.java:94
esa.opensf.osfi.TimeValue.parse
static TimeValue parse(final String s)
Definition: TimeValue.java:146
esa.opensf.osfi.Parameter.getType
String getType()
Definition: Parameter.java:562
esa.opensf.osfi.Parameter.getOtherAttributes
Map< String, String > getOtherAttributes()
Definition: Parameter.java:592
esa.opensf.osfi.Logger.warning
static void warning(String message)
Definition: Logger.java:84
esa.opensf.osfi.xmlutils.XmlFiles.W3C_NS_URI_XSD10
static final String W3C_NS_URI_XSD10
Definition: XmlFiles.java:36
esa.opensf.osfi.ParamParserComplex.getType
ParamType getType()
Definition: ParamParserComplex.java:196
esa.opensf.osfi.ArrayNode.getDataAtSub
final V getDataAtSub(final int... indices)
Definition: ArrayNode.java:86
esa.opensf.osfi.ParamReader.write
void write()
Definition: ParamReader.java:300
esa.opensf.osfi.ArrayNode.hashCode
int hashCode()
Definition: ArrayNode.java:147
esa.opensf.osfi.Logger.isDebugging
static boolean isDebugging()
Definition: Logger.java:35
esa.opensf.osfi.LoadResult.SEV_INFO
static final int SEV_INFO
Definition: LoadResult.java:31
esa.opensf.osfi.Logger
Definition: Logger.java:23
esa.opensf.osfi.ParamReader
Definition: ParamReader.java:41
esa.opensf.osfi.Parameter.getMatrixInt
int[][] getMatrixInt()
Definition: Parameter.java:315
esa.opensf.osfi.Parameter.getFileValue
String getFileValue()
Definition: Parameter.java:214
esa.opensf.osfi.Parameter.addOtherAttribute
void addOtherAttribute(final String key, final String val)
Definition: Parameter.java:588
esa.opensf.osfi.TimeValue.equals
boolean equals(final Object other)
Definition: TimeValue.java:123
esa.opensf.osfi.Parameter.getNdims
int getNdims()
Definition: Parameter.java:482
esa.opensf.osfi.UsageReader
Definition: UsageReader.java:29
esa.opensf.osfi.Parameter.getMax
String getMax()
Definition: Parameter.java:544
esa.opensf.osfi.TimeValue.hour
final byte hour
Definition: TimeValue.java:41
esa.opensf.osfi.Logger.isColored
static boolean isColored()
Definition: Logger.java:60
esa.opensf.osfi.TimeValue.nanosec
final int nanosec
Definition: TimeValue.java:47
esa.opensf.osfi.LoadResult.unwrap
R unwrap()
Definition: LoadResult.java:102
esa.opensf.osfi.Logger.info
static void info(String message)
Definition: Logger.java:92
esa.opensf.osfi.Parameter.getUnits
String getUnits()
Definition: Parameter.java:535
esa.opensf.osfi.LoadResult.SEV_WARNING
static final int SEV_WARNING
Definition: LoadResult.java:36
esa.opensf.osfi.TimeValue.minute
final byte minute
Definition: TimeValue.java:43
esa.opensf.osfi.Parameter.getDoubleValue
double getDoubleValue()
Definition: Parameter.java:182
esa.opensf.osfi.ParamParserComplex.getMatrixValue
String getMatrixValue()
Definition: ParamParserComplex.java:200
esa.opensf.osfi.LoadResult
Definition: LoadResult.java:29
esa.opensf.osfi.ParamParserComplex.EXTATTR_PATHSEP
static final String EXTATTR_PATHSEP
Definition: ParamParserComplex.java:32
esa.opensf.osfi.Parameter.getStringValue
String getStringValue()
Definition: Parameter.java:206
esa.opensf.osfi.TimeValue
Definition: TimeValue.java:26
esa.opensf.osfi.Logger.printMessage
static void printMessage(String logType, String message, String fg, String bg)
Definition: Logger.java:160
esa.opensf.osfi.xmlutils.DomUtils
Definition: DomUtils.java:31
esa.opensf.osfi.Parameter.getVectorString
String[] getVectorString()
Definition: Parameter.java:265
esa.opensf.osfi.Parameter.ParamType
Definition: Parameter.java:29
esa.opensf.osfi.ArrayNode.getData
V getData()
Definition: ArrayNode.java:48
esa.opensf.osfi.ParamReader.WarningType
Definition: ParamReader.java:48
esa.opensf.osfi.ParamParserComplex.getExtraAttrs
java.util.Map< String, String > getExtraAttrs()
Definition: ParamParserComplex.java:216
esa.opensf.osfi.Parameter.ParamComplexType.ARRAY
ARRAY
Definition: Parameter.java:57
esa.opensf.osfi.ParamReader.load
static LoadResult< ParamReader > load(final LoadResult< Document > xml, final boolean stopOnSingleParamError, final Map< String, Parameter > map, final Set< WarningType > suppWarns)
Definition: ParamReader.java:158
esa.opensf.osfi.xmlutils.XmlParseException
Definition: XmlParseException.java:18
esa.opensf.osfi.xmlutils.DomUtils.validateAgainst
static boolean validateAgainst(final Node docOrEl, final String xsdFile)
Definition: DomUtils.java:40
esa.opensf.osfi.ParamReader.ParamReader
ParamReader(final String xmlFile, final String xsdFile)
Definition: ParamReader.java:100
esa.opensf.osfi.XMLParser.read
static Document read(final String xmlFile)
Definition: XMLParser.java:74
esa.opensf.osfi.Parameter.getBooleanValue
boolean getBooleanValue()
Definition: Parameter.java:190
esa.opensf.osfi.TimeValue.dom
final byte dom
Definition: TimeValue.java:39
esa.opensf.osfi.ParamReader.validateAgainst
boolean validateAgainst(final String xsdFile)
Definition: ParamReader.java:211
esa.opensf.osfi.ParamReader.getAllParameters
Map< String, Parameter > getAllParameters()
Definition: ParamReader.java:265
esa.opensf.osfi.Parameter.getMin
String getMin()
Definition: Parameter.java:553
esa.opensf.osfi.XMLParser
Definition: XMLParser.java:35
esa.opensf.osfi.Parameter
Definition: Parameter.java:27
esa.opensf.osfi.ParamParserComplex.ParamParserComplex
ParamParserComplex(final Element paramNode, final String paramPath)
Definition: ParamParserComplex.java:52
esa.opensf.osfi.ParamParserComplex.getComplexType
ParamComplexType getComplexType()
Definition: ParamParserComplex.java:212
esa.opensf.osfi.Parameter.getRawValue
String getRawValue()
Definition: Parameter.java:155
esa.opensf.osfi.ArrayNode
Definition: ArrayNode.java:27
esa.opensf.osfi.TimeValue.toString
String toString()
Definition: TimeValue.java:81
esa.opensf.osfi.Parameter.getOtherAttribute
String getOtherAttribute(final String key)
Definition: Parameter.java:596
esa.opensf.osfi.ArrayNode.getDimsEnvelope
final List< Integer > getDimsEnvelope()
Definition: ArrayNode.java:102
esa.opensf.osfi.LoadResult.loadEvents
final List< Event > loadEvents
Definition: LoadResult.java:72
esa.opensf.osfi.Parameter.fileExist
boolean[][] fileExist()
Definition: Parameter.java:384
esa.opensf.osfi.xmlutils.DomUtils.validateAgainstInternalSchema
static boolean validateAgainstInternalSchema(final Node docOrEl)
Definition: DomUtils.java:48
esa.opensf.osfi.Parameter.getVectorInt
int[] getVectorInt()
Definition: Parameter.java:237
esa.opensf.osfi.ArrayNode.Raw
Definition: ArrayNode.java:158
esa.opensf.osfi.ArrayNode.equals
boolean equals(Object other)
Definition: ArrayNode.java:135
esa.opensf.osfi.ParamReader.isStandardAttribute
static boolean isStandardAttribute(String key)
Definition: ParamReader.java:315
esa.opensf.osfi.TimeValue.month
final byte month
Definition: TimeValue.java:37
esa.opensf.osfi.ParamParserComplex.getRootNode
ArrayNode.Raw getRootNode()
Definition: ParamParserComplex.java:204
esa.opensf.osfi.Parameter.getMatrixDouble
double[][] getMatrixDouble()
Definition: Parameter.java:323
esa.opensf.osfi.ParamReader.validateAgainstInternalSchema
boolean validateAgainstInternalSchema()
Definition: ParamReader.java:217
esa.opensf.osfi.xmlutils.DomUtils.getChildElements
static List< Element > getChildElements(final Node node, final String name)
Definition: DomUtils.java:83
esa.opensf.osfi.XMLParser.getChildElements
static List< Element > getChildElements(Node node, String name)
Definition: XMLParser.java:99
esa.opensf.osfi.LoadResult.Event
Definition: LoadResult.java:52
esa.opensf.osfi.ParamReader.getParameters
List< Parameter > getParameters(String groupName)
Definition: ParamReader.java:254
esa.opensf.osfi.xmlutils.XmlFiles.validate
static LoadResult< Void > validate(final File xmlFile, final File schemaFile, final String schemaLanguage, final boolean stopOnFirstError)
Definition: XmlFiles.java:166
esa.opensf.osfi.ParamParserComplex
Definition: ParamParserComplex.java:29
esa.opensf.osfi.Logger.error
static void error(String message)
Definition: Logger.java:76
esa.opensf.osfi.ParamParserComplex.getListDims
List< Integer > getListDims()
Definition: ParamParserComplex.java:208
esa.opensf.osfi.Logger.qualityReport
static void qualityReport(String name, String value)
Definition: Logger.java:149
esa.opensf.osfi.ParamReader.WarningType.NO_PARAMETERS_UNDER_GROUP
NO_PARAMETERS_UNDER_GROUP
Definition: ParamReader.java:50
esa.opensf.osfi.ParamReader.load
static LoadResult< ParamReader > load(final LoadResult< Document > xml, final boolean stopOnSingleParamError)
Definition: ParamReader.java:201