Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow for special constant to be non-conformant with object's data type #893

Merged
merged 4 commits into from
May 8, 2024
Merged

Allow for special constant to be non-conformant with object's data type #893

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
307521d
add unit tests
May 2, 2024
1f0d5eb
fix
May 2, 2024
15250ab
Update SpecialConstantChecker.java
al-niessner May 6, 2024
641266c
proper merge of main
May 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
174 changes: 174 additions & 0 deletions src/main/java/gov/nasa/pds/tools/validate/SpecialConstantChecker.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,174 @@
package gov.nasa.pds.tools.validate;

import java.math.BigDecimal;
import java.math.BigInteger;
import gov.nasa.arc.pds.xml.generated.SpecialConstants;
import gov.nasa.pds.tools.validate.content.ProblemReporter;
import gov.nasa.pds.tools.validate.content.SpecialConstantBitPatternTransforms;

public class SpecialConstantChecker {
/**
* Use this when the special constant may not conform to the type constraints
* meaning only string comparisons can be done.
* @param value
* @param constants
* @return
*/
public static boolean isNonConformantSpecialConstant(String value, SpecialConstants constants) {
boolean matched = false;
if (constants != null) {
matched |= value.equals(constants.getErrorConstant());
matched |= value.equals(constants.getInvalidConstant());
matched |= value.equals(constants.getMissingConstant());
//matched |= value.equals(constants.getHighInstrumentSaturation());
//matched |= value.equals(constants.getHighRepresentationSaturation());
//matched |= value.equals(constants.getLowInstrumentSaturation());
//matched |= value.equals(constants.getLowRepresentationSaturation());
matched |= value.equals(constants.getNotApplicableConstant());
matched |= value.equals(constants.getSaturatedConstant());
matched |= value.equals(constants.getUnknownConstant());
}
return matched;
}
/**
* Checks if the given value is a Special Constant defined in the label.
* Use this when check string values first then values and bit patterns
* meaning the special constant must conform to the data type constraints.
*
* @param value The value to check.
* @param constants An object representation of the Special_Constants area in a label.
*
* @return true if the given value is a Special Constant.
*/
public static boolean isConformantSpecialConstant(Number value, SpecialConstants constants,
ProblemReporter reporter) {
boolean matched = false;
boolean matchEdge = true;
boolean rangeChecked = false;
matched |= SpecialConstantChecker.sameContent (value, constants.getErrorConstant());
matched |= SpecialConstantChecker.sameContent (value, constants.getInvalidConstant());
matched |= SpecialConstantChecker.sameContent (value, constants.getMissingConstant());
matched |= SpecialConstantChecker.sameContent (value, constants.getHighInstrumentSaturation());
matched |= SpecialConstantChecker.sameContent (value, constants.getHighRepresentationSaturation());
matched |= SpecialConstantChecker.sameContent (value, constants.getLowInstrumentSaturation());
matched |= SpecialConstantChecker.sameContent (value, constants.getLowRepresentationSaturation());
matched |= SpecialConstantChecker.sameContent (value, constants.getNotApplicableConstant());
matched |= SpecialConstantChecker.sameContent (value, constants.getSaturatedConstant());
matched |= SpecialConstantChecker.sameContent (value, constants.getUnknownConstant());
if (matched) return true;
if (constants.getValidMaximum() != null) {
int comparison = 0;
rangeChecked = true;
if (value instanceof BigDecimal) {
comparison = ((BigDecimal) value)
.compareTo(SpecialConstantBitPatternTransforms.asBigDecimal(constants.getValidMaximum()));
} else if (value instanceof BigInteger) {
comparison = ((BigInteger) value)
.compareTo(SpecialConstantBitPatternTransforms.asBigInt(constants.getValidMaximum()));
} else {
if (constants.getValidMaximum().contains(".") ||
((constants.getValidMaximum().contains("e") || constants.getValidMaximum().contains("E")) &&
!(constants.getValidMaximum().startsWith("0x") || constants.getValidMaximum().startsWith("0X") || constants.getValidMaximum().startsWith("16#")))) {
comparison = Double.valueOf(value.doubleValue())
.compareTo(SpecialConstantBitPatternTransforms.asBigDecimal(constants.getValidMaximum()).doubleValue());
} else {
Long con = SpecialConstantBitPatternTransforms.asBigInt(constants.getValidMaximum()).longValue();
Long val = value.longValue();
if (value instanceof Double) {
val = Long.valueOf(Double.doubleToRawLongBits((Double)value));
if (con.equals (val)) {
matchEdge &= true;
} else {
comparison = ((Double)value).compareTo(Double.longBitsToDouble(con));
}
} else if (value instanceof Float) {
val = Long.valueOf(Float.floatToRawIntBits((Float)value)) & 0xFFFFFFFFL;
if (con.equals (val)) {
matchEdge &= true;
} else {
comparison = ((Float)value).compareTo(Float.intBitsToFloat(con.intValue()));
}
} else {
comparison = val.compareTo(con);
}
}
}
if (0 < comparison) {
reporter.addProblem("Field has a value '" + value.toString()
+ "' that is greater than the defined maximum value '" + constants.getValidMaximum()
+ "'. ");
}
matchEdge &= comparison == 0;
}
if (constants.getValidMinimum() != null) {
int comparison = 0;
rangeChecked = true;
if (value instanceof BigDecimal) {
comparison = ((BigDecimal) value)
.compareTo(SpecialConstantBitPatternTransforms.asBigDecimal(constants.getValidMinimum()));
} else if (value instanceof BigInteger) {
comparison = ((BigInteger) value)
.compareTo(SpecialConstantBitPatternTransforms.asBigInt(constants.getValidMinimum()));
} else {
if (constants.getValidMinimum().contains(".") ||
((constants.getValidMinimum().contains("e") || constants.getValidMinimum().contains("E")) &&
!(constants.getValidMinimum().startsWith("0x") || constants.getValidMinimum().startsWith("0X") || constants.getValidMinimum().startsWith("16#")))) {
comparison = Double.valueOf(value.doubleValue())
.compareTo(SpecialConstantBitPatternTransforms.asBigDecimal(constants.getValidMinimum()).doubleValue());
} else {
Long con = SpecialConstantBitPatternTransforms.asBigInt(constants.getValidMinimum()).longValue();
Long val = value.longValue();
if (value instanceof Double) {
val = Long.valueOf(Double.doubleToRawLongBits((Double)value));
if (con.equals (val)) {
matchEdge &= true;
} else {
comparison = ((Double)value).compareTo(Double.longBitsToDouble(con));
}
} else if (value instanceof Float) {
val = Long.valueOf(Float.floatToRawIntBits((Float)value)) & 0xFFFFFFFFL;
if (con.equals (val)) {
matchEdge &= true;
} else {
comparison = ((Float)value).compareTo(Float.intBitsToFloat(con.intValue()));
}
} else {
comparison = val.compareTo(con);
}
}
}
if (comparison < 0) {
reporter.addProblem("Field has a value '" + value.toString()
+ "' that is less than the defined minimum value '" + constants.getValidMinimum()
+ "'. ");
}
matchEdge = comparison == 0;
}
return rangeChecked ? matchEdge : false;
}
public static boolean sameContent (Number number, String constant_repr) {
if (constant_repr == null) return false;
if (number.toString().equals(constant_repr)) {
return true;
}
if (number instanceof BigDecimal) number = ((BigDecimal)number).doubleValue();
if (number instanceof Byte) number = BigInteger.valueOf(number.byteValue());
if (number instanceof Double) number = BigInteger.valueOf(Double.doubleToRawLongBits((Double)number));
if (number instanceof Float) number = BigInteger.valueOf(Float.floatToRawIntBits((Float)number) & 0xFFFFFFFFL);
if (number instanceof Integer) number = BigInteger.valueOf(number.intValue());
if (number instanceof Long) number = BigInteger.valueOf(number.longValue());
if (number instanceof Short) number = BigInteger.valueOf(number.shortValue());
boolean repr_decimal = constant_repr.contains (".") ||
((constant_repr.contains("E") || constant_repr.contains("e")) &&
!(constant_repr.startsWith("0x") || constant_repr.startsWith("0X")));
if (repr_decimal) {
BigDecimal constant = SpecialConstantBitPatternTransforms.asBigDecimal(constant_repr);
return constant.equals (number);
} else {
BigInteger constant = SpecialConstantBitPatternTransforms.asBigInt(constant_repr);
BigInteger value = (BigInteger)number;
return constant.xor (value).longValue() == 0L;
}
}

}
147 changes: 2 additions & 145 deletions src/main/java/gov/nasa/pds/tools/validate/content/array/ArrayContentValidator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@

import java.io.IOException;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.math.RoundingMode;
import java.net.URL;
import java.util.Arrays;
Expand All @@ -27,15 +26,14 @@
import gov.nasa.arc.pds.xml.generated.Array;
import gov.nasa.arc.pds.xml.generated.ElementArray;
import gov.nasa.arc.pds.xml.generated.ObjectStatistics;
import gov.nasa.arc.pds.xml.generated.SpecialConstants;
import gov.nasa.pds.label.object.ArrayObject;
import gov.nasa.pds.objectAccess.DataType.NumericDataType;
import gov.nasa.pds.tools.label.ExceptionType;
import gov.nasa.pds.tools.validate.ProblemDefinition;
import gov.nasa.pds.tools.validate.ProblemListener;
import gov.nasa.pds.tools.validate.ProblemType;
import gov.nasa.pds.tools.validate.SpecialConstantChecker;
import gov.nasa.pds.tools.validate.content.ProblemReporter;
import gov.nasa.pds.tools.validate.content.SpecialConstantBitPatternTransforms;
import gov.nasa.pds.validate.constants.Constants;

/**
Expand Down Expand Up @@ -291,7 +289,7 @@ private void validatePosition(Array array, ArrayObject arrayObject, ArrayLocatio
ProblemReporter reporter = new ArrayProblemReporter(this, ExceptionType.WARNING,
ProblemType.ARRAY_VALUE_OUT_OF_SPECIAL_CONSTANT_MIN_MAX_RANGE, ArrayContentValidator.tableNameReportStr,
location);
isSpecialConstant = isSpecialConstant(value, array.getSpecialConstants(), reporter);
isSpecialConstant = SpecialConstantChecker.isConformantSpecialConstant(value, array.getSpecialConstants(), reporter);
}

// LOG.debug("validatePosition:dataType,isSpecialConstant,array.getSpecialConstants()
Expand Down Expand Up @@ -331,147 +329,6 @@ private boolean isNanOrInf (Number value) {
}
return false;
}
private static boolean sameContent (Number number, String constant_repr) {
if (constant_repr == null) return false;
if (number.toString().equals(constant_repr)) {
return true;
}
if (number instanceof BigDecimal) number = ((BigDecimal)number).doubleValue();
if (number instanceof Byte) number = BigInteger.valueOf(number.byteValue());
if (number instanceof Double) number = BigInteger.valueOf(Double.doubleToRawLongBits((Double)number));
if (number instanceof Float) number = BigInteger.valueOf(Float.floatToRawIntBits((Float)number) & 0xFFFFFFFFL);
if (number instanceof Integer) number = BigInteger.valueOf(number.intValue());
if (number instanceof Long) number = BigInteger.valueOf(number.longValue());
if (number instanceof Short) number = BigInteger.valueOf(number.shortValue());
boolean repr_decimal = constant_repr.contains (".") ||
((constant_repr.contains("E") || constant_repr.contains("e")) &&
!(constant_repr.startsWith("0x") || constant_repr.startsWith("0X")));
if (repr_decimal) {
BigDecimal constant = SpecialConstantBitPatternTransforms.asBigDecimal(constant_repr);
return constant.equals (number);
} else {
BigInteger constant = SpecialConstantBitPatternTransforms.asBigInt(constant_repr);
BigInteger value = (BigInteger)number;
return constant.xor (value).longValue() == 0L;
}
}
/**
* Checks if the given value is a Special Constant defined in the label.
*
* @param value The value to check.
* @param constants An object representation of the Special_Constants area in a label.
*
* @return true if the given value is a Special Constant.
*/
public static boolean isSpecialConstant(Number value, SpecialConstants constants,
ProblemReporter reporter) {
boolean matched = false;
boolean matchEdge = true;
boolean rangeChecked = false;
matched |= sameContent (value, constants.getErrorConstant());
matched |= sameContent (value, constants.getInvalidConstant());
matched |= sameContent (value, constants.getMissingConstant());
matched |= sameContent (value, constants.getHighInstrumentSaturation());
matched |= sameContent (value, constants.getHighRepresentationSaturation());
matched |= sameContent (value, constants.getLowInstrumentSaturation());
matched |= sameContent (value, constants.getLowRepresentationSaturation());
matched |= sameContent (value, constants.getNotApplicableConstant());
matched |= sameContent (value, constants.getSaturatedConstant());
matched |= sameContent (value, constants.getUnknownConstant());
if (matched) return true;
if (constants.getValidMaximum() != null) {
int comparison = 0;
rangeChecked = true;
if (value instanceof BigDecimal) {
comparison = ((BigDecimal) value)
.compareTo(SpecialConstantBitPatternTransforms.asBigDecimal(constants.getValidMaximum()));
} else if (value instanceof BigInteger) {
comparison = ((BigInteger) value)
.compareTo(SpecialConstantBitPatternTransforms.asBigInt(constants.getValidMaximum()));
} else {
if (constants.getValidMaximum().contains(".") ||
((constants.getValidMaximum().contains("e") || constants.getValidMaximum().contains("E")) &&
!(constants.getValidMaximum().startsWith("0x") || constants.getValidMaximum().startsWith("0X") || constants.getValidMaximum().startsWith("16#")))) {
comparison = Double.valueOf(value.doubleValue())
.compareTo(SpecialConstantBitPatternTransforms.asBigDecimal(constants.getValidMaximum()).doubleValue());
} else {
Long con = SpecialConstantBitPatternTransforms.asBigInt(constants.getValidMaximum()).longValue();
Long val = value.longValue();
if (value instanceof Double) {
val = Long.valueOf(Double.doubleToRawLongBits((Double)value));
if (con.equals (val)) {
matchEdge &= true;
} else {
comparison = ((Double)value).compareTo(Double.longBitsToDouble(con));
}
} else if (value instanceof Float) {
val = Long.valueOf(Float.floatToRawIntBits((Float)value)) & 0xFFFFFFFFL;
if (con.equals (val)) {
matchEdge &= true;
} else {
comparison = ((Float)value).compareTo(Float.intBitsToFloat(con.intValue()));
}
} else {
comparison = val.compareTo(con);
}
}
}
if (0 < comparison) {
reporter.addProblem("Field has a value '" + value.toString()
+ "' that is greater than the defined maximum value '" + constants.getValidMaximum()
+ "'. ");
}
matchEdge &= comparison == 0;
}
if (constants.getValidMinimum() != null) {
int comparison = 0;
rangeChecked = true;
if (value instanceof BigDecimal) {
comparison = ((BigDecimal) value)
.compareTo(SpecialConstantBitPatternTransforms.asBigDecimal(constants.getValidMinimum()));
} else if (value instanceof BigInteger) {
comparison = ((BigInteger) value)
.compareTo(SpecialConstantBitPatternTransforms.asBigInt(constants.getValidMinimum()));
} else {
if (constants.getValidMinimum().contains(".") ||
((constants.getValidMinimum().contains("e") || constants.getValidMinimum().contains("E")) &&
!(constants.getValidMinimum().startsWith("0x") || constants.getValidMinimum().startsWith("0X") || constants.getValidMinimum().startsWith("16#")))) {
comparison = Double.valueOf(value.doubleValue())
.compareTo(SpecialConstantBitPatternTransforms.asBigDecimal(constants.getValidMinimum()).doubleValue());
} else {
Long con = SpecialConstantBitPatternTransforms.asBigInt(constants.getValidMinimum()).longValue();
Long val = value.longValue();
if (value instanceof Double) {
val = Long.valueOf(Double.doubleToRawLongBits((Double)value));
if (con.equals (val)) {
matchEdge &= true;
} else {
comparison = ((Double)value).compareTo(Double.longBitsToDouble(con));
}
} else if (value instanceof Float) {
val = Long.valueOf(Float.floatToRawIntBits((Float)value)) & 0xFFFFFFFFL;
if (con.equals (val)) {
matchEdge &= true;
} else {
float a = Float.intBitsToFloat(con.intValue());
float b = (Float)value;
comparison = ((Float)value).compareTo(Float.intBitsToFloat(con.intValue()));
}
} else {
comparison = val.compareTo(con);
}
}
}
if (comparison < 0) {
reporter.addProblem("Field has a value '" + value.toString()
+ "' that is less than the defined minimum value '" + constants.getValidMinimum()
+ "'. ");
}
matchEdge = comparison == 0;
}
return rangeChecked ? matchEdge : false;
}

/**
* Checks the given number against the object statistics characteristics as defined in the product
* label.
Expand Down
Loading