001/**
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.camel.model.dataformat;
018
019import javax.xml.bind.annotation.XmlAccessType;
020import javax.xml.bind.annotation.XmlAccessorType;
021import javax.xml.bind.annotation.XmlAttribute;
022import javax.xml.bind.annotation.XmlRootElement;
023
024import org.apache.camel.CamelContext;
025import org.apache.camel.spi.DataFormat;
026import org.apache.camel.spi.Metadata;
027
028/**
029 * UniVocity fixed-width data format
030 */
031@Metadata(label = "dataformat,transformation,csv", title = "uniVocity Fixed Length")
032@XmlRootElement(name = "univocity-fixed")
033@XmlAccessorType(XmlAccessType.FIELD)
034public class UniVocityFixedWidthDataFormat extends UniVocityAbstractDataFormat {
035    @XmlAttribute
036    protected Boolean skipTrailingCharsUntilNewline;
037    @XmlAttribute
038    protected Boolean recordEndsOnNewline;
039    @XmlAttribute @Metadata(defaultValue = " ")
040    protected String padding;
041
042    public UniVocityFixedWidthDataFormat() {
043        super("univocity-fixed");
044    }
045
046    public Boolean getSkipTrailingCharsUntilNewline() {
047        return skipTrailingCharsUntilNewline;
048    }
049
050    /**
051     * Whether or not the trailing characters until new line must be ignored.
052     * <p/>
053     * The default value is false
054     */
055    public void setSkipTrailingCharsUntilNewline(Boolean skipTrailingCharsUntilNewline) {
056        this.skipTrailingCharsUntilNewline = skipTrailingCharsUntilNewline;
057    }
058
059    public Boolean getRecordEndsOnNewline() {
060        return recordEndsOnNewline;
061    }
062
063    /**
064     * Whether or not the record ends on new line.
065     * <p/>
066     * The default value is false
067     */
068    public void setRecordEndsOnNewline(Boolean recordEndsOnNewline) {
069        this.recordEndsOnNewline = recordEndsOnNewline;
070    }
071
072    public String getPadding() {
073        return padding;
074    }
075
076    /**
077     * The padding character.
078     * <p/>
079     * The default value is a space
080     */
081    public void setPadding(String padding) {
082        this.padding = padding;
083    }
084
085    @Override
086    protected void configureDataFormat(DataFormat dataFormat, CamelContext camelContext) {
087        super.configureDataFormat(dataFormat, camelContext);
088
089        if (headers != null) {
090            int[] lengths = new int[headers.size()];
091            for (int i = 0; i < lengths.length; i++) {
092                Integer length = headers.get(i).getLength();
093                if (length == null) {
094                    throw new IllegalArgumentException("The length of all headers must be defined.");
095                }
096                lengths[i] = length;
097            }
098            setProperty(camelContext, dataFormat, "fieldLengths", lengths);
099        }
100        if (skipTrailingCharsUntilNewline != null) {
101            setProperty(camelContext, dataFormat, "skipTrailingCharsUntilNewline", skipTrailingCharsUntilNewline);
102        }
103        if (recordEndsOnNewline != null) {
104            setProperty(camelContext, dataFormat, "recordEndsOnNewline", recordEndsOnNewline);
105        }
106        if (padding != null) {
107            setProperty(camelContext, dataFormat, "padding", singleCharOf("padding", padding));
108        }
109    }
110}