serialize.AnnotationSerializer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of annotationpro-format Show documentation
Library to read and write Annotation Pro files
The newest version!
package serialize;

import model.Annotation;
import model.Layer;
import model.Segment;

import java.util.HashMap;
import java.util.Map;

/**
 * Helps to serialize annotation as java objects to xml string content
 * Main method is: serializeAnnotation which gets annotation java object and
 * returns string with annotation in xml format.
 *
 * XML BUILDER
 * Decided not to use xml builder to be sure format always is exactly the same
 * as in Annotation PRO and is independent from library version
 *
 * @author Wojciech Klessa
 * @since 2017-01-10
 */
public class AnnotationSerializer {
    /**
     * Helps to serialize annotation java object to xml string
     * @param annotation Annotation as java object
     * @return Xml string with annotation
     */
    public String serializeAnnotation(Annotation annotation) {
        StringBuilder xmlContent = new StringBuilder();
        StringBuilder segmentsContent = new StringBuilder();

        xmlContent.append(createAnnotationHeader());

        // layers and segments
        for (Layer layer : annotation.getLayers()) {
            xmlContent.append(serializeLayer(layer));
            for (Segment segment : layer.getSegments()) {
                segmentsContent.append(serializeSegment(segment));
            }
        }
        xmlContent.append(segmentsContent.toString());

        // configuration items
        xmlContent.append(serializeConfiguration(annotation.getConfiguration()));

        xmlContent.append(createAnnotationFooter());

        return xmlContent.toString();
    }

    /**
     * Serializes one segment from java object to xml string
     * @param segment Segment java object
     * @return Xml string with segment information
     */
    private String serializeSegment(Segment segment) {

        String template = "  \n" +
                "    %s\n" +
                "    %s\n" +
                "    %s\n" +
                "    %s\n" +
                "    %s\n" +
                "    %s\n" +
                "    %s\n" +
                "    %s\n" +
                "    %s\n" +
                "    %s\n" +
                "    %s\n" +
                "    %s\n" +
                "    %s\n" +
                "    %s\n" +
                "    %s\n" +
                "    %s\n" +
                "    %s\n" +
                "    %s\n" +
                "    %s\n" +
                "  \n";

        return String.format(template,
                segment.getId(),
                segment.getIdLayer(),
                segment.getLabel(),
                segment.getForeColor(),
                segment.getBackColor(),
                segment.getBorderColor(),
                segment.getStart(),
                segment.getDuration(),
                segment.isSelected(),
                segment.getFeature(),
                segment.getLanguage(),
                segment.getGroup(),
                segment.getName(),
                segment.getParameter1(),
                segment.getParameter2(),
                segment.getParameter3(),
                segment.isMarkerEnabled(),
                segment.getMarker(),
                segment.getRScript()
        );
    }

    /**
     * Serializes layer from java object to xml string
     * @param layer Layer object
     * @return Xml string with layer information
     */
    private String serializeLayer(Layer layer) {

        String template = "  \n" +
                "    %s\n" +
                "    %s\n" +
                "    %s\n" +
                "    %s\n" +
                "    %s\n" +
                "    %s\n" +
                "    %s\n" +
                "    %s\n" +
                "    %s\n" +
                "    %s\n" +
                "    %s\n" +
                "    %s\n" +
                "    %s\n" +
                "    %s\n" +
                "    %s\n" +
                "    %s\n" +
                "    %s\n" +
                "    %s\n" +
                "    %s\n" +
                "    %s\n" +
                "  \n";

        return String.format(template,
                layer.getId(),
                layer.getName(),
                layer.getForeColor(),
                layer.getBackColor(),
                layer.isSelected(),
                layer.getHeight(),
                layer.getCoordinateControlStyle(),
                layer.isLocked(),
                layer.isClosed(),
                layer.isShowOnSpectrogram(),
                layer.isShowAsChart(),
                layer.getChartMinimum(),
                layer.getChartMaximum(),
                layer.isShowBoundaries(),
                layer.isIncludeInFrequency(),
                layer.getParameter1Name(),
                layer.getParameter2Name(),
                layer.getParameter3Name(),
                layer.isVisible(),
                layer.getFontSize()
        );
    }

    /**
     * Serializes configuration from HashMap to xml string
     * @param configuration HashMap with configuration entries
     * @return Xml string with configuration information
     */
    private String serializeConfiguration(HashMap configuration) {

        String template = "  \n" +
                "    %s\n" +
                "    %s\n" +
                "  \n";

        StringBuilder builder = new StringBuilder();

        for (Map.Entry entry : configuration.entrySet()) {
            builder.append(String.format(template,
                    entry.getKey(),
                    entry.getValue())
            );
        }

        return builder.toString();
    }

    /**
     * Creates in simply way xml header
     * This simply method has been chosen to support annotation pro xml format
     * @return Xml string with xml header
     */
    private String createAnnotationHeader() {
        return "\n" +
                "\n";
    }

    /**
     * Creates in simply way xml footer
     * This simply method has been chosen to support annotation pro xml format
     * @return Xml string with xml footer
     */
    private String createAnnotationFooter() {
        return "";
    }
}