Package com.biomatters.geneious.publicapi.implementations

Class EValue

    • Constructor Detail

      • EValue

        public EValue​(double value,
              int decimalPlacesDisplayed)
        Parameters:
        value -
        decimalPlacesDisplayed -

      • EValue

        public EValue()
        this constructor is only here to be used immediately prior to fromXML.

      • EValue

        public EValue​(double value)
        Parameters:
        value - e-value

    • Method Detail

      • setDecimalPlacesDisplayed

        public void setDecimalPlacesDisplayed​(int decimalPlacesDisplayed)
        Set number of decimal places in representation.
        Parameters:
        decimalPlacesDisplayed - number of places

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • intValue

        public int intValue()
        Specified by:
        intValue in class java.lang.Number

      • longValue

        public long longValue()
        Specified by:
        longValue in class java.lang.Number

      • floatValue

        public float floatValue()
        Specified by:
        floatValue in class java.lang.Number

      • doubleValue

        public double doubleValue()
        Specified by:
        doubleValue in class java.lang.Number

      • compareTo

        public int compareTo​(EValue o)
        Specified by:
        compareTo in interface java.lang.Comparable<EValue>

      • toXML

        public org.jdom.Element toXML()
        eg. 
         <evalue>
    <value>0.00</value>
    <decimalPlacesDisplayed>2</decimalPlacesDisplayed>
 </evalue>
        Specified by:
        toXML in interface XMLSerializable
        Returns:
        object encoded as a JDOM element

      • toXML

        public org.jdom.Element toXML​(Geneious.MajorVersion majorVersion,
                              jebl.util.ProgressListener progressListener)
        Description copied from interface: XMLSerializable.OldVersionCompatible
        Serializes this class to XML format, potentially to a format readable by an earlier version of Geneious. It is acceptable for the XML to include unnecessary tags that will be ignored by the earlier version. For example if the implementation has only extended the XML since the earlier version, then the XML returned may be identical to the XML returned for the current version.

        See XMLSerializable.toXML() for a more detailed description of what it means to serialize to XML.

        All classes that implement this method must also implement XMLSerializable.toXML() and should delegate back to this method using Geneious.getMajorVersion() and ProgressListener.EMPTY as parameters.

        Specified by:
        toXML in interface XMLSerializable.OldVersionCompatible
        Parameters:
        majorVersion - the major version of Geneious to serialize to XML for. For example "6.0" but not "6.0.0". This must be a version returned greater or equal to a version returned from getVersionSupport(VersionSupportType.OldestVersionSerializableTo) and must never be greater than the current version (Geneious.getMajorVersion())
        progressListener - for reporting progress and cancelling
        Returns:
        object encoded as a JDOM element

      • fromXML

        public void fromXML​(org.jdom.Element element)
             throws XMLSerializationException
        Description copied from interface: XMLSerializable
        Restore the object from the JDOM Element returned by XMLSerializable.toXML().

        This method generally should not be called directly. Instead, you should usually call XMLSerializer.classFromXML(org.jdom.Element) or XMLSerializer.classFromXML(org.jdom.Element, Class) which calls this method internally.

        It is optional to implement this method. Instead of implementing an empty constructor and implementing this method properly, the implementation may instead throw an UnsupportedOperationException and implement a constructor that takes a single Element as a parameter. This allows for cleaner code such as support for final fields in the XMLSerializable class.

        The element parameter should not be modified since it may be reused. If you need a modified version of it, take a copy with Element.clone().

        Specified by:
        fromXML in interface XMLSerializable
        Parameters:
        element - representation from a previous call to XMLSerializable.toXML()
        Throws:
        XMLSerializationException - if the Element can't be converted into this type of object