org.apache.camel.model.dataformat.UniVocityAbstractDataFormat Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of camel-core Show documentation
Show all versions of camel-core Show documentation
The Core Camel Java DSL based router
/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.apache.camel.model.dataformat;
import java.util.ArrayList;
import java.util.List;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElementRef;
import org.apache.camel.CamelContext;
import org.apache.camel.model.DataFormatDefinition;
import org.apache.camel.spi.DataFormat;
import org.apache.camel.spi.Metadata;
/**
* Represents the common parts of all uniVocity {@link org.apache.camel.spi.DataFormat} parsers.
*/
@Metadata(label = "dataformat,transformation,csv", title = "uniVocity")
@XmlAccessorType(XmlAccessType.FIELD)
public abstract class UniVocityAbstractDataFormat extends DataFormatDefinition {
@XmlAttribute
protected String nullValue;
@XmlAttribute @Metadata(defaultValue = "true")
protected Boolean skipEmptyLines;
@XmlAttribute @Metadata(defaultValue = "true")
protected Boolean ignoreTrailingWhitespaces;
@XmlAttribute @Metadata(defaultValue = "true")
protected Boolean ignoreLeadingWhitespaces;
@XmlAttribute
protected Boolean headersDisabled;
@XmlElementRef
protected List headers;
@XmlAttribute
protected Boolean headerExtractionEnabled;
@XmlAttribute
protected Integer numberOfRecordsToRead;
@XmlAttribute
protected String emptyValue;
@XmlAttribute
protected String lineSeparator;
@XmlAttribute @Metadata(defaultValue = "\\n")
protected String normalizedLineSeparator;
@XmlAttribute @Metadata(defaultValue = "#")
protected String comment;
@XmlAttribute
protected Boolean lazyLoad;
@XmlAttribute
protected Boolean asMap;
protected UniVocityAbstractDataFormat() {
// This constructor is needed by jaxb for schema generation
}
protected UniVocityAbstractDataFormat(String dataFormatName) {
super(dataFormatName);
}
public String getNullValue() {
return nullValue;
}
/**
* The string representation of a null value.
*
* The default value is null
*/
public void setNullValue(String nullValue) {
this.nullValue = nullValue;
}
public Boolean getSkipEmptyLines() {
return skipEmptyLines;
}
/**
* Whether or not the empty lines must be ignored.
*
* The default value is true
*/
public void setSkipEmptyLines(Boolean skipEmptyLines) {
this.skipEmptyLines = skipEmptyLines;
}
public Boolean getIgnoreTrailingWhitespaces() {
return ignoreTrailingWhitespaces;
}
/**
* Whether or not the trailing white spaces must ignored.
*
* The default value is true
*/
public void setIgnoreTrailingWhitespaces(Boolean ignoreTrailingWhitespaces) {
this.ignoreTrailingWhitespaces = ignoreTrailingWhitespaces;
}
public Boolean getIgnoreLeadingWhitespaces() {
return ignoreLeadingWhitespaces;
}
/**
* Whether or not the leading white spaces must be ignored.
*
* The default value is true
*/
public void setIgnoreLeadingWhitespaces(Boolean ignoreLeadingWhitespaces) {
this.ignoreLeadingWhitespaces = ignoreLeadingWhitespaces;
}
public Boolean getHeadersDisabled() {
return headersDisabled;
}
/**
* Whether or not the headers are disabled. When defined, this option explicitly sets the headers as null which indicates that there is no header.
*
* The default value is false
*/
public void setHeadersDisabled(Boolean headersDisabled) {
this.headersDisabled = headersDisabled;
}
public List getHeaders() {
return headers;
}
/**
* The headers to use.
*/
public void setHeaders(List headers) {
this.headers = headers;
}
public Boolean getHeaderExtractionEnabled() {
return headerExtractionEnabled;
}
/**
* Whether or not the header must be read in the first line of the test document
*
* The default value is false
*/
public void setHeaderExtractionEnabled(Boolean headerExtractionEnabled) {
this.headerExtractionEnabled = headerExtractionEnabled;
}
public Integer getNumberOfRecordsToRead() {
return numberOfRecordsToRead;
}
/**
* The maximum number of record to read.
*/
public void setNumberOfRecordsToRead(Integer numberOfRecordsToRead) {
this.numberOfRecordsToRead = numberOfRecordsToRead;
}
public String getEmptyValue() {
return emptyValue;
}
/**
* The String representation of an empty value
*/
public void setEmptyValue(String emptyValue) {
this.emptyValue = emptyValue;
}
public String getLineSeparator() {
return lineSeparator;
}
/**
* The line separator of the files
*
* The default value is to use the JVM platform line separator
*/
public void setLineSeparator(String lineSeparator) {
this.lineSeparator = lineSeparator;
}
public String getNormalizedLineSeparator() {
return normalizedLineSeparator;
}
/**
* The normalized line separator of the files
*
* The default value is \n
*/
public void setNormalizedLineSeparator(String normalizedLineSeparator) {
this.normalizedLineSeparator = normalizedLineSeparator;
}
public String getComment() {
return comment;
}
/**
* The comment symbol.
*
* The default value is #
*/
public void setComment(String comment) {
this.comment = comment;
}
public Boolean getLazyLoad() {
return lazyLoad;
}
/**
* Whether the unmarshalling should produce an iterator that reads the lines on the fly or if all the lines must be read at one.
*
* The default value is false
*/
public void setLazyLoad(Boolean lazyLoad) {
this.lazyLoad = lazyLoad;
}
public Boolean getAsMap() {
return asMap;
}
/**
* Whether the unmarshalling should produce maps for the lines values instead of lists.
* It requires to have header (either defined or collected).
*
* The default value is false
*/
public void setAsMap(Boolean asMap) {
this.asMap = asMap;
}
@Override
protected void configureDataFormat(DataFormat dataFormat, CamelContext camelContext) {
super.configureDataFormat(dataFormat, camelContext);
if (nullValue != null) {
setProperty(camelContext, dataFormat, "nullValue", nullValue);
}
if (skipEmptyLines != null) {
setProperty(camelContext, dataFormat, "skipEmptyLines", skipEmptyLines);
}
if (ignoreTrailingWhitespaces != null) {
setProperty(camelContext, dataFormat, "ignoreTrailingWhitespaces", ignoreTrailingWhitespaces);
}
if (ignoreLeadingWhitespaces != null) {
setProperty(camelContext, dataFormat, "ignoreLeadingWhitespaces", ignoreLeadingWhitespaces);
}
if (headersDisabled != null) {
setProperty(camelContext, dataFormat, "headersDisabled", headersDisabled);
}
String[] validHeaderNames = getValidHeaderNames();
if (validHeaderNames != null) {
setProperty(camelContext, dataFormat, "headers", validHeaderNames);
}
if (headerExtractionEnabled != null) {
setProperty(camelContext, dataFormat, "headerExtractionEnabled", headerExtractionEnabled);
}
if (numberOfRecordsToRead != null) {
setProperty(camelContext, dataFormat, "numberOfRecordsToRead", numberOfRecordsToRead);
}
if (emptyValue != null) {
setProperty(camelContext, dataFormat, "emptyValue", emptyValue);
}
if (lineSeparator != null) {
setProperty(camelContext, dataFormat, "lineSeparator", lineSeparator);
}
if (normalizedLineSeparator != null) {
setProperty(camelContext, dataFormat, "normalizedLineSeparator", singleCharOf("normalizedLineSeparator", normalizedLineSeparator));
}
if (comment != null) {
setProperty(camelContext, dataFormat, "comment", singleCharOf("comment", comment));
}
if (lazyLoad != null) {
setProperty(camelContext, dataFormat, "lazyLoad", lazyLoad);
}
if (asMap != null) {
setProperty(camelContext, dataFormat, "asMap", asMap);
}
}
protected static Character singleCharOf(String attributeName, String string) {
if (string.length() != 1) {
throw new IllegalArgumentException("Only one character must be defined for " + attributeName);
}
return string.charAt(0);
}
/**
* Gets only the headers with non-null and non-empty names. It returns {@code null} if there's no such headers.
*
* @return The headers with non-null and non-empty names
*/
private String[] getValidHeaderNames() {
if (headers == null) {
return null;
}
List names = new ArrayList(headers.size());
for (UniVocityHeader header : headers) {
if (header.getName() != null && !header.getName().isEmpty()) {
names.add(header.getName());
}
}
return names.isEmpty() ? null : names.toArray(new String[names.size()]);
}
}