org.metafacture.formeta.FormetaEncoder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of metafacture-formeta Show documentation
Modules for reading and writing data in Formeta format
The newest version!
/*
 * Copyright 2013, 2014 Deutsche Nationalbibliothek
 *
 * 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.metafacture.formeta;

import org.metafacture.formeta.formatter.Formatter;
import org.metafacture.formeta.formatter.FormatterStyle;
import org.metafacture.framework.FluxCommand;
import org.metafacture.framework.ObjectReceiver;
import org.metafacture.framework.StreamReceiver;
import org.metafacture.framework.annotations.Description;
import org.metafacture.framework.annotations.In;
import org.metafacture.framework.annotations.Out;
import org.metafacture.framework.helpers.DefaultStreamPipe;

/**
 * Encodes streams in formeta format.
 *
 * @author Christoph Böhme
 *
 */
@Description("Encodes streams in formeta format.")
@In(StreamReceiver.class)
@Out(String.class)
@FluxCommand("encode-formeta")
public final class FormetaEncoder extends DefaultStreamPipe> {

    private FormatterStyle style = FormatterStyle.CONCISE;
    private Formatter formatter = style.createFormatter();

    /**
     * Creates an instance of {@link FormetaEncoder}.
     */
    public FormetaEncoder() {
    }

    /**
     * Gets the style.
     *
     * @return the {@link FormatterStyle}
     */
    public FormatterStyle getStyle() {
        return style;
    }

    /**
     * Sets the style of the Formatter.
     *
     * @param formatterStyle the {@link FormatterStyle}
     */
    public void setStyle(final FormatterStyle formatterStyle) {
        this.style = formatterStyle;
        formatter = formatterStyle.createFormatter();
    }

    @Override
    public void startRecord(final String identifier) {
        formatter.reset();
        formatter.startGroup(identifier);
    }

    @Override
    public void endRecord() {
        formatter.endGroup();
        getReceiver().process(formatter.toString());
    }

    @Override
    public void startEntity(final String name) {
        formatter.startGroup(name);
    }

    @Override
    public void endEntity() {
        formatter.endGroup();
    }

    @Override
    public void literal(final String name, final String value) {
        formatter.literal(name, value);
    }

}