All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.xmlcml.cml.tools.EntryTool Maven / Gradle / Ivy

/**
 *    Copyright 2011 Peter Murray-Rust et. al.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

package org.xmlcml.cml.tools;

import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import nu.xom.Attribute;
import nu.xom.Node;
import nu.xom.Nodes;

import org.apache.log4j.Logger;
import org.xmlcml.cml.base.AbstractTool;
import org.xmlcml.cml.base.CMLConstants;
import org.xmlcml.cml.base.CMLElement;
import org.xmlcml.cml.base.CMLUtil;
import org.xmlcml.cml.element.CMLArray;
import org.xmlcml.cml.element.CMLEntry;
import org.xmlcml.cml.element.CMLFormula;
import org.xmlcml.cml.element.CMLMatrix;
import org.xmlcml.cml.element.CMLParameter;
import org.xmlcml.cml.element.CMLProperty;
import org.xmlcml.cml.element.CMLScalar;
import org.xmlcml.cml.element.CMLTable;
import org.xmlcml.cml.element.CMLVector3;
import org.xmlcml.euclid.EuclidRuntimeException;
import org.xmlcml.euclid.IntArray;
import org.xmlcml.euclid.RealArray;
import org.xmlcml.euclid.Util;

/** additional tools for entry.
 * manages much of the per-entry validation and processing
 * @author pmr
 *
 */
public class EntryTool extends AbstractTool {

    private static Logger LOG = Logger.getLogger(EntryTool.class);

    /** general whitespace regex */
    public final static String ESCAPED_WHITESPACE = CMLConstants.S_BACKSLASH + S_BACKSLASH + "s";
    /** whitespace comma slash */
    public final static String DELIMITERS =
            ESCAPED_WHITESPACE + S_PIPE + S_COMMA + S_PIPE + S_SLASH;
    protected CMLEntry entry = null;
    private boolean ignoreCaseOfEnumerations;
    protected String delimiter = null;
    private String prefix = null;
    protected boolean failOnError;
    private Set valueSet = new HashSet();
    private List enumerationList;
    private Set enumerationSet;
    private Set ignoreCaseSet;

    /**
     * Private constructor only used in package (Singleton Pattern).
     * use dictionaryTool.createEntryTool(entry) for normal use
     * @param entry
     */
    protected EntryTool(CMLEntry entry) {
        this.entry = entry;
        //ensureSupportDataType();
    }

    /**
     * Gets EntryTool associated with entry.
     * if null creates one and sets it in entry
     * @param entry
     * @return tool
     */
    public static EntryTool getOrCreateTool(CMLEntry entry) {
        EntryTool entryTool = null;
        if (entry != null) {
            entryTool = (EntryTool) entry.getTool();
            if (entryTool == null) {
                entryTool = new EntryTool(entry);
                entry.setTool(entryTool);
            }
        }
        return entryTool;
    }

    /**
     * get entry.
     *
     * @return the entry
     */
    public CMLEntry getEntry() {
        return entry;
    }

    /**
     * @return the delimiter
     */
    public String getDelimiter() {
        return (delimiter == null) ? delimiter = CMLConstants.S_SPACE : delimiter;
    }

    /**
     * @param delimiter the delimiter to set
     */
    public void setDelimiter(String delimiter) {
        this.delimiter = delimiter;
    }

    /**
     * @return the failOnError
     */
    public boolean isFailOnError() {
        return failOnError;
    }

    /**
     * @param failOnError the failOnError to set
     */
    public void setFailOnError(boolean failOnError) {
        this.failOnError = failOnError;
    }

    /**
     * @return the ignoreCaseOfEnumerations
     */
    public boolean isIgnoreCaseOfEnumerations() {
        return ignoreCaseOfEnumerations;
    }

    /**
     * @param ignoreCaseOfEnumerations the ignoreCaseOfEnumerations to set
     */
    public void setIgnoreCaseOfEnumerations(boolean ignoreCaseOfEnumerations) {
        this.ignoreCaseOfEnumerations = ignoreCaseOfEnumerations;
    }

    /**
     * @return the prefix
     */
    public String getPrefix() {
        return prefix;
    }

    /**
     * @param prefix the prefix to set
     */
    public void setPrefix(String prefix) {
        this.prefix = prefix;
    }

    public void validate(CMLElement element) {
        if (element instanceof CMLScalar) {
            validate((CMLScalar) element);
        } else if (element instanceof CMLArray) {
            validate((CMLArray) element);
        } else if (element instanceof CMLFormula) {
            validate((CMLFormula) element);
        } else if (element instanceof CMLParameter) {
            validate((CMLParameter) element);
        } else if (element instanceof CMLProperty) {
            validate((CMLProperty) element);
        } else if (element instanceof CMLTable) {
            validate((CMLTable) element);
        } else {
            LOG.debug("Cannot validate: " + element.getClass());
        }
    }

    private void validate(CMLParameter parameter) {
    	// validate scalar required
    }

    private void validate(CMLProperty property) {
    	// validate scalar required
    }

    private void validate(CMLScalar scalar) {
        String entryDataType = entry.getDataType();
        String scalarDataType = scalar.getDataType();
        validate(scalar, entryDataType, scalarDataType);
        validateValue(scalarDataType, scalar.getDictRef(), scalar.getValue());
    }

    private void validateValue(String dataType, String name, String value) {
        if (XSD_DOUBLE.equals(dataType)) {
            if (!Util.isFloat(value)) {
                throw new RuntimeException(name +
                        ": expected number, found: " + value);
            }
        }
    }

    private void validate(CMLArray array) {
        String entryDataType = entry.getDataType();
        String scalarDataType = array.getDataType();
        validate(array, entryDataType, scalarDataType);

    }

    private void validate(CMLFormula formula) {
//    	String entryDataType = entry.getDataType();
//    	String scalarDataType = array.getDataType();
//    	validate(array, entryDataType, scalarDataType);
    }

    private void validate(CMLTable table) {
//    	String entryDataType = entry.getDataType();
//    	String scalarDataType = array.getDataType();
//    	validate(array, entryDataType, scalarDataType);
    }

    private void validate(CMLElement element, String entryDataType, String dataDataType) {
        String id = element.getAttributeValue("id");
        String dictRef = element.getAttributeValue("dictRef");
        if (dataDataType == null) {
            if (entryDataType == null || entryDataType.equals(XSD_STRING)) {
                // OK
            } else {
                throw new RuntimeException("data for (" + id + ") must have data type");
            }
        } else {
            if (!dataDataType.equals(entryDataType)) {
                throw new RuntimeException(id + S_SLASH + dictRef + ": entry (" + entryDataType + ") and data {" + dataDataType + "} are of different types");
            }
        }
    }

    /** add scalar string to a CMLElement.
     * checks against enumerations and pattern
     * @param name localname
     * @param value
     * @return scalar
     */
    public CMLScalar createStringScalar(String name, String value) {
        EntryTool.checkEmptyName(name);
        if (failOnError) {
//			this.checkValueAgainstEnumerations(value);
            this.checkPattern(value);
        }
        CMLScalar scalar = createScalar(name);
        scalar.setDataType(XSD_STRING);
        scalar.setXMLContent(value);
        return scalar;
    }

    /** add scalar float to a CMLElement.
     * NO checking
     * @param name localname
     * @param value
     * @return TODO
     */
    public CMLScalar createDoubleScalar(String name, double value) {
        EntryTool.checkEmptyName(name);
        if (failOnError) {
            this.checkNumericValue((double) value);
        }
        CMLScalar scalar = createScalar(name);
        scalar.setValue(value);
        return scalar;
    }

    /**
     * @param name
     * @return
     * @throws RuntimeException
     */
    private CMLScalar createScalar(String name) throws RuntimeException {
        CMLScalar scalar = new CMLScalar();
        if (prefix != null) {
            scalar.setDictRef(prefix + S_COLON + name.toLowerCase());
        }
        return scalar;
    }

    /** add scalar int to a CMLElement.
     * checks values
     * @param name localname
     * @param value
     * @return TODO
     */
    public CMLScalar createIntegerScalar(String name, int value) {
        EntryTool.checkEmptyName(name);
        if (failOnError) {
//			this.checkValueAgainstEnumerations(value);
            this.checkNumericValue((double) value);
        }
        CMLScalar scalar = createScalar(name);
        scalar.setValue(value);
        return scalar;
    }

    /** add real array to a CMLElement.
     * @param name localname
     * @param realArray
     * @return TODO
     */
    public CMLArray createDoubleArray(String name, RealArray realArray) {
        EntryTool.checkEmptyName(name);
        if (failOnError) {
            this.checkDoubleRange(realArray.getMin(), realArray.getMax());
        }
        double[] values = realArray.getArray();
        CMLArray array = new CMLArray(values);
        if (prefix != null) {
            array.setDictRef(prefix + S_COLON + name.toLowerCase());
        }
        return array;
    }

    /** add integer array to a CMLElement.
     * @param name localname
     * @param intArray
     * @return TODO
     */
    public CMLArray createIntegerArray(String name, IntArray intArray) {
        EntryTool.checkEmptyName(name);
        int[] values = intArray.getArray();
        CMLArray array = new CMLArray();
        if (prefix != null) {
            array.setDictRef(prefix + S_COLON + name.toLowerCase());
        }
        array.setDataType(XSD_FLOAT);
        array.setArray(values);
        return array;
    }

    /** add string array to a CMLElement.
     * @param name localname
     * @param values
     * @return Array
     */
    public CMLArray createStringArray(String name, String[] values) {
        EntryTool.checkEmptyName(name);
        CMLArray array = new CMLArray();
        if (prefix != null) {
            array.setDictRef(prefix + S_COLON + name.toLowerCase());
        }
        array.setDataType(XSD_FLOAT);
        array.setArray(values);
        return array;
    }

    /** create data.
     *
     * @param name
     * @param value
     * @return data
     */
    public CMLElement createDoubleScalarOrDoubleArray(String name, String value) {

        CMLElement element = null;
//    	CMLElements enumerations = entry.getEnumerationElements();
//		if (enumerations != null && enumerations.size() > 0) {
//			throw new RuntimeException("enumerated float not supported: "+value+" for "+name);
//		}
        Attribute minLengthAttribute = entry.getMinLengthAttribute();
        Attribute maxLengthAttribute = entry.getMaxLengthAttribute();
        Attribute lengthAttribute = entry.getLengthAttribute();

        // arrays
        double minInclusive = Double.NaN;
        double maxInclusive = Double.NaN;
        if ((lengthAttribute != null ||
                minLengthAttribute != null ||
                maxLengthAttribute != null) && delimiter != null) {
            String[] ss = value.split(delimiter);
            this.checkArrayLength(ss, name);
            // add arrays
            try {
                RealArray ra = new RealArray(ss);
                element = this.createDoubleArray(name, ra);
            } catch (EuclidRuntimeException e) {
                if (failOnError) {
                    throw new RuntimeException(e + " for " + name);
                } else {
                    // add string if fails
                    element = this.createStringScalar(name, value);
                }
            }
        } else {
            // known to be scalar
            double valueD = Double.NaN;
            try {
                valueD = new Double(value);
                element = this.createDoubleScalar(name, valueD);
                minInclusive = Math.min(minInclusive, valueD);
                maxInclusive = Math.max(maxInclusive, valueD);
            } catch (NumberFormatException e) {
                if (failOnError) {
                    throw new RuntimeException("expected double for " + name + " found: " + value);
                } else {
                    // add string if fails
                    element = this.createStringScalar(name, value);
                }
            }
        }
        return element;
    }

    public CMLElement createElement(String name, String value) {
        CMLElement element = null;
    	String dataType = entry.getDataType();
    	if (dataType == null || dataType.equalsIgnoreCase(XSD_STRING)) {
    		element = createStringScalarOrStringArray(name, value);
    	} else if (dataType.equalsIgnoreCase(XSD_FLOAT) || dataType.equals(XSD_DOUBLE)) {
    		element = createDoubleScalarOrDoubleArray(name, value);
    	} else if (dataType.equalsIgnoreCase(XSD_INTEGER)) {
    		element = createIntegerScalarOrIntegerArray(name, value);
        }
        return element;

    }
    /** create integer data.
     *
     * @param name
     * @param value
     * @return integer
     */
    public CMLElement createIntegerScalarOrIntegerArray(String name, String value) {

        CMLElement element = null;
        Attribute minLengthAttribute = entry.getMinLengthAttribute();
        Attribute maxLengthAttribute = entry.getMaxLengthAttribute();
        Attribute lengthAttribute = entry.getLengthAttribute();

        int minInclusive = Integer.MAX_VALUE;
        int maxInclusive = -Integer.MAX_VALUE;
        if ((lengthAttribute != null ||
                minLengthAttribute != null ||
                maxLengthAttribute != null) && delimiter != null) {
            String[] ss = value.split(delimiter);
            this.checkArrayLength(ss, name);
            // fields in keywords should not be parsed
            try {
                IntArray ia = new IntArray(ss);
                element = this.createIntegerArray(name, ia);
                minInclusive = ia.getMin();
                maxInclusive = ia.getMax();
                this.checkIntegerRange(minInclusive, maxInclusive);
            } catch (EuclidRuntimeException e) {
                if (failOnError) {
                    throw (e);
                } else {
                    element = this.createStringScalar(name, value);
                }
            }
        } else {
            try {
                int ivalue = Integer.parseInt(value);
                element = this.createIntegerScalar(name, ivalue);
            } catch (NumberFormatException e) {
                throw new RuntimeException("Bad integer: " + value);
            }
        }
        return element;
    }

    /** create string data.
     *
     * @param name
     * @param value
     * @return string
     */
    public static CMLElement createUnknownStringScalar(String name, String value) {
        CMLScalar scalar = new CMLScalar();
        scalar.setXMLContent(value);
        return scalar;
    }

    /** create string data.
     *
     * @param name
     * @param value
     * @return string
     */
    public CMLElement createStringScalarOrStringArray(String name, String value) {

        CMLElement element = null;
        Attribute minLengthAttribute = entry.getMinLengthAttribute();
        Attribute maxLengthAttribute = entry.getMaxLengthAttribute();
        Attribute lengthAttribute = entry.getLengthAttribute();

        if ((lengthAttribute != null ||
                minLengthAttribute != null ||
                maxLengthAttribute != null) && delimiter != null) {
            String[] ss = value.split(delimiter);
            this.checkArrayLength(ss, name);
            // fields in keywords should not be parsed
            try {
                element = this.createStringArray(name, ss);
            } catch (EuclidRuntimeException e) {
                if (failOnError) {
                    throw (e);
                } else {
                    element = this.createStringScalar(name, value);
                }
            }
        } else {
            element = this.createStringScalar(name, value);
        }
        return element;
    }

    /** create parameter.
     *
     * @param name
     * @param value
     * @return parameter
     */
    public CMLParameter createParameter(
            String name, String value) {
        CMLParameter parameter = new CMLParameter();

        CMLElement element = null;
        if (XSD_STRING.equals(entry.getDataType())) {
            element = createStringScalarOrStringArray(name, value);
        } else if (XSD_INTEGER.equals(entry.getDataType())) {
            element = createIntegerScalarOrIntegerArray(name, value);
        } else if (XSD_FLOAT.equals(entry.getDataType())) {
            element = createDoubleScalarOrDoubleArray(name, value);
        }
        parameter.appendChild(element);
        Attribute dictRef = element.getAttribute("dictRef");
        if (dictRef != null) {
            dictRef.detach();
            parameter.addAttribute(dictRef);
        }
        return parameter;
    }

    /** add scalar date to a CMLElement.
     * will try to parse and canonicalise the date. If fails, throws
     * RuntimeException
     * @param name localname
     * @param value of date
     * @return data
     */
    public CMLScalar createDate(String name, String value) {
        EntryTool.checkEmptyName(name);
        String canonicalValue = Util.getCanonicalDate(value);
        if (canonicalValue == null) {
            throw new RuntimeException("Cannot parse as date: " + value);
        }
        CMLScalar scalar = createScalar(name);
        scalar.setDataType(XSD_DATE);
        scalar.setXMLContent(value);
        return scalar;
    }

    /** create formula
     * will try to parse and canonicalise the formula.
     * If fails, throws RuntimeException
     * @param name localname
     * @param value of formula
     * @return formula
     */
    public CMLFormula createFormula(String name, String value) {
        EntryTool.checkEmptyName(name);
        CMLFormula formula = CMLFormula.createFormula(value);
        if (formula == null) {
            throw new RuntimeException("Cannot parse as formula: " + value);
        }
        if (prefix != null) {
            formula.setDictRef(prefix + S_COLON + name.toLowerCase());
        }
        return formula;
    }

    /** create Vector3 from string.
     * @param name localname
     * @param value of vector
     * @return vector
     */
    public CMLVector3 createVector3(String name, String value) {
        EntryTool.checkEmptyName(name);
        RealArray array = new RealArray(value.split(this.getDelimiter()));
        CMLVector3 vector3 = new CMLVector3(array.getArray());
        if (prefix != null) {
            vector3.setDictRef(prefix + S_COLON + name.toLowerCase());
        }
        return vector3;
    }

    /** create Vector3 from string.
     * @param name localname
     * @param value of vector
     * @return matrix
     */
    public CMLMatrix createMatrix(String name, String value) {
        // FIXME needs to return property
        EntryTool.checkEmptyName(name);
        CMLMatrix matrix = null;
        List propertys = CMLUtil.getQueryNodes(entry,
                CMLProperty.NS + "[" + CMLMatrix.NS + "]", CMLConstants.CML_XPATH);
        if (propertys.size() != 1) {
            throw new RuntimeException(
                    "Cannot find property/matrix template in entry: " + entry.getId());
        }
        CMLProperty property = (CMLProperty) propertys.get(0);
        CMLMatrix template = (CMLMatrix) property.getChildCMLElement(CMLMatrix.TAG, 0);
        String matrixType = template.getMatrixType();
        int rows = (template.getRowsAttribute() == null) ? 0 : template.getRows();
        int columns = (template.getColumnsAttribute() == null) ? 0 : template.getColumns();
        RealArray array = new RealArray(value.split(this.getDelimiter()));
        if (rows != 0 && rows == columns && rows * columns == array.size()) {
            matrix = new CMLMatrix(rows, columns, array.getArray());
            matrix.copyAttributesFrom(template);
        } else if (CMLMatrix.Type.SQUARE_SYMMETRIC_LT.value.equals(matrixType)) {
            matrix = CMLMatrix.createSquareMatrix(
                    array, rows, CMLMatrix.Type.SQUARE_SYMMETRIC_LT);
            matrix.copyAttributesFrom(template);
        } else if (CMLMatrix.Type.SQUARE_SYMMETRIC_UT.value.equals(matrixType)) {
            matrix = CMLMatrix.createSquareMatrix(
                    array, rows, CMLMatrix.Type.SQUARE_SYMMETRIC_UT);
            matrix.copyAttributesFrom(template);
        }
        return matrix;
    }

    /** check length.
     *
     * @param ss
     * @param name
     */
    public void checkArrayLength(String[] ss, String name) {
        if (entry.getLengthAttribute() != null) {
            int l = entry.getLength();
            if (l != ss.length) {
                throw new RuntimeException("Expected array of size " + l + "; found: " + ss.length + " for " + name);
            }
        }
        if (entry.getMinLengthAttribute() != null) {
            int l = entry.getMinLength();
            if (l > ss.length) {
                throw new RuntimeException("Expected array of size >= " + l + "); found: " + ss.length + " for " + name);
            }
        }
        if (entry.getMaxLengthAttribute() != null) {
            int l = entry.getMaxLength();
            if (l < ss.length) {
                throw new RuntimeException("Expected array of size =< " + l + "); found: " + ss.length + " for " + name);
            }
        }
    }

    /** check value of data.
     *
     * @param value
     */
    public void checkNumericValue(double value) {
        if (entry.getMinInclusiveAttribute() != null) {
            if (value < entry.getMinInclusive()) {
                throw new RuntimeException("value (" + value + ") less than minimum: " +
                        entry.getMinInclusiveAttribute() + " for " + entry.getId());
            }
        }
        if (entry.getMaxInclusiveAttribute() != null) {
            if (value > entry.getMaxInclusive()) {
                throw new RuntimeException("value (" + value + ") greater than maximum: " +
                        entry.getMaxInclusiveAttribute());
            }
        }
    }

    /** check against range.
     *
     * @param minInclusive
     * @param maxInclusive
     */
    public void checkDoubleRange(double minInclusive, double maxInclusive) {
        Attribute minInclusiveAttribute = (entry == null) ? null : entry.getMinInclusiveAttribute();
        Attribute maxInclusiveAttribute = (entry == null) ? null : entry.getMaxInclusiveAttribute();
        if (minInclusiveAttribute != null && !Double.isNaN(minInclusive)) {
            if (minInclusive < entry.getMinInclusive()) {
                throw new RuntimeException("value (" +
                        minInclusive + ") outside minimum: " + entry.getMinInclusive() +
                        " for " + entry.getId());
            }
        }
        if (maxInclusiveAttribute != null && !Double.isNaN(maxInclusive)) {
            if (maxInclusive > entry.getMaxInclusive()) {
                throw new RuntimeException("value (" +
                        maxInclusive + ") outside maximum: " + entry.getMaxInclusive() +
                        " for " + entry.getId());
            }
        }
    }

    /** check integer range.
     *
     * @param minInclusive
     * @param maxInclusive
     */
    public void checkIntegerRange(int minInclusive, int maxInclusive) {
        Attribute minInclusiveAttribute = (entry == null) ? null : entry.getMinInclusiveAttribute();
        Attribute maxInclusiveAttribute = (entry == null) ? null : entry.getMaxInclusiveAttribute();
        if (minInclusiveAttribute != null && !Double.isNaN(minInclusive)) {
            if (minInclusive < entry.getMinInclusive()) {
                throw new RuntimeException("value (" +
                        minInclusive + ") outside minimum: " + entry.getMinInclusive() +
                        " for " + entry.getId());
            }
        }
        if (maxInclusiveAttribute != null && !Double.isNaN(maxInclusive)) {
            if (maxInclusive > entry.getMaxInclusive()) {
                throw new RuntimeException("value (" +
                        maxInclusive + ") outside maximum: " + entry.getMaxInclusive() +
                        " for " + entry.getId());
            }
        }
    }

    public List ensureEnumerations() {
        if (enumerationList == null) {
            enumerationList = new ArrayList();
            Nodes nodes = entry.query("*[local-name()='enumeration']");
            for (int i = 0; i < nodes.size(); i++) {
                enumerationList.add(nodes.get(i).getValue());
            }
        }
        if (ignoreCaseOfEnumerations && ignoreCaseSet == null) {
            ignoreCaseSet = new HashSet();
            for (String s : enumerationList) {
                ignoreCaseSet.add(s.toLowerCase());
            }
        }
        if (enumerationSet == null) {
            enumerationSet = new HashSet();
            for (String s : enumerationList) {
                enumerationSet.add(s);
            }
        }
        return enumerationList;
    }

    /** does the value correspond to an enuemrated value?
     * if ignoreCaseOfEnumerations set ignores case
     * @param value
     * @return
     */
    public boolean containsEnumeratedValue(String value) {
        ensureEnumerations();
        return (this.ignoreCaseOfEnumerations &&
                ignoreCaseSet.contains(value.toLowerCase()) ||
                enumerationSet.contains(value));
    }

    /** check pattern.
     *
     * @param value
     */
    public void checkPattern(String value) {
        String patternS = entry.getPattern();
        if (patternS != null) {
            Pattern pattern = Pattern.compile(patternS);
            Matcher matcher = pattern.matcher(value);
            if (!matcher.matches()) {
                throw new RuntimeException("Value (" + value +
                        ") does not match enumeration for: " + entry.getId());
            }
        }
    }

    /** check empty.
     *
     * @param name
     */
    public static void checkEmptyName(String name) {
        if (name == null) {
            throw new RuntimeException("null name");
        }
        if (S_EMPTY.equals(name.trim())) {
            throw new RuntimeException("empty name");
        }
        if (name.indexOf(S_COLON) != -1) {
            throw new RuntimeException("name cannot contain colon");
        }
    }

    /** add value.
     *
     * @param value
     */
    public void addValue(String value) {
        valueSet.add(value);
    }

    private String guessDataType() {
        int count = 0;
        boolean couldBeBoolean = true;
        boolean couldBeInt = true;
        boolean couldBeIntArray = false;
        boolean couldBeDate = true;
        boolean couldBeComplex = true;
        boolean couldBeFloat = true;
        boolean couldBeFloatArray = false;
        for (String s : valueSet) {
            count++;
            couldBeBoolean &=
                    s.equalsIgnoreCase("true") ||
                    s.equalsIgnoreCase("false");
            couldBeDate &= (Util.getCanonicalDate(s) != null);
            // might be array
            couldBeIntArray &= (Util.isIntArray(s, DELIMITERS));
            couldBeFloatArray &= (Util.isFloatArray(s, DELIMITERS));
            couldBeInt &= (Util.isInt(s));
            couldBeFloat &= (Util.isFloat(s));

        }

        boolean couldBeEnum = count > 5;
        String type = XSD_STRING;
        if (false) {
        } else if (couldBeBoolean) {
            type = XSD_BOOLEAN;
        } else if (couldBeInt) {
            type = XSD_INTEGER;
        } else if (couldBeFloat) {
            type = XSD_FLOAT;
        } else if (couldBeDate) {
            type = XSD_DATE;
        } else if (couldBeComplex) {
//			type = FPX_COMPLEX;
        } else if (couldBeEnum) {
            // assume string and add dummy enumeration to flag type
            type = XSD_STRING;
        }
        entry.setDataType(type);
        return type;
    }

    /** update enumerations.
     */
    public void updateEnumerations() {
        LOG.debug("====" + entry.getId() + "===");
        String dataType = entry.getDataType();
        if (dataType == null || XSD_STRING.equals(dataType)) {
            dataType = guessDataType();
        }
// 
//		// if this is an enumerated entry add possible values
//		CMLElements enumerations = entry.getEnumerationElements();
//		if (dataType.equals(XSD_STRING) &&
//			entry.getEnumerationElements().size() == 0) {
//			CMLEnumeration enumeration = new CMLEnumeration();
//			enumeration.setId(CMLEnumeration.DUMMY_ENUM);
//			enumeration.setCMLValue(CMLEnumeration.DUMMY_ENUM);
//			entry.addEnumeration(enumeration);
//		}
//		for (CMLEnumeration enumeration : enumerations) {
//			try {
//				entry.updateIndex();
//			} catch (RuntimeException e) {
//				entry.debug("BAD INDEX");
//				throw e;
//			}
//			String s = enumeration.getCMLValue();
//			if (ignoreCaseOfEnumerations) {
//				s = s.toLowerCase();
//			}
//		}
        // remove enumerations if type is float or boolean
//		if (dataType.equals(XSD_FLOAT) || dataType.equals(XSD_BOOLEAN)) {
//			for (CMLEnumeration enumeration : enumerations) {
//				enumeration.detach();
//			}
//		} else if (entry.getEnumerationElements().size() > 0) {
//			// if there are already enumerations, add more if distinct
//			for (String s : valueSet) {
//				String id = CMLUtil.makeId(s);
//				if (entry.getIndexableById(id) == null) {
//					CMLEnumeration enumeration = new CMLEnumeration();
//					enumeration.setId(id);
//					enumeration.setCMLValue(s);
//					entry.addIndexable(enumeration);
//				}
//			}
//		}
        // remove dummy entry if there are other enumerations
//		if (entry.getEnumerationElements().size() > 1) {
//			CMLEnumeration dummyEnumeration = (CMLEnumeration)
//				entry.getIndexableById(CMLEnumeration.DUMMY_ENUM);
//			if (dummyEnumeration != null) {
//				dummyEnumeration.detach();
//			}
//		}// 
    }

    /** create term from title or name.
     * term = title else = name
     * @param element
     * @return term
     */
    public static String createTerm(CMLElement element) {
        String term = null;
        String title = element.getAttributeValue("title");
        String name = element.getAttributeValue("name");
        if (name != null) {
            term = name;
        } else if (title != null) {
            term = title;
        }
        return term;
    }

}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy