/**
* Copyright 2011-2017 Asakusa Framework Team.
*
* 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 com.asakusafw.dmdl.directio.csv.driver;
import java.text.SimpleDateFormat;
import com.asakusafw.dmdl.model.AstNode;
import com.asakusafw.dmdl.semantics.Trait;
import com.asakusafw.runtime.io.csv.CsvConfiguration;
import com.asakusafw.runtime.value.Date;
import com.asakusafw.runtime.value.DateTime;
/**
* Attributes for CSV supported data models.
* @since 0.2.5
* @version 0.5.2
*/
public class CsvFormatTrait implements Trait<CsvFormatTrait> {
private final AstNode originalAst;
private final Configuration configuration;
/**
* Creates and returns a new instance.
* @param originalAst the original AST, or {@code null} if this is an ad-hoc element
* @param configuration the CSV configuration
* @throws IllegalArgumentException if some parameters were {@code null}
*/
public CsvFormatTrait(AstNode originalAst, Configuration configuration) {
if (configuration == null) {
throw new IllegalArgumentException("configuration must not be null"); //$NON-NLS-1$
}
this.originalAst = originalAst;
this.configuration = configuration;
}
/**
* Returns CSV configuration.
* @return the configuration
*/
public Configuration getConfiguration() {
return configuration;
}
@Override
public AstNode getOriginalAst() {
return originalAst;
}
/**
* The CSV format configuration.
* @since 0.2.5
* @version 0.7.3
* @see CsvConfiguration
*/
public static class Configuration {
private String charsetName = "UTF-8"; //$NON-NLS-1$
private boolean allowLinefeed = false;
private boolean enableHeader = false;
private boolean forceHeader = CsvConfiguration.DEFAULT_FORCE_CONSUME_HEADER;
private String trueFormat = CsvConfiguration.DEFAULT_TRUE_FORMAT;
private String falseFormat = CsvConfiguration.DEFAULT_FALSE_FORMAT;
private String dateFormat = CsvConfiguration.DEFAULT_DATE_FORMAT;
private String dateTimeFormat = CsvConfiguration.DEFAULT_DATE_TIME_FORMAT;
private String codecName = null;
/**
* Returns the charset name.
* @return the charset name (default: UTF-8)
*/
public String getCharsetName() {
return charsetName;
}
/**
* Sets the charset name.
* @param charsetName the charset name
*/
public void setCharsetName(String charsetName) {
this.charsetName = charsetName;
}
/**
* Returns whether the header is required.
* @return {@code true} if header is required, otherwise {@code false} (default: false)
*/
public boolean isEnableHeader() {
return enableHeader;
}
/**
* Configures whether the header is required.
* @param enableHeader {@code true} to require header, otherwise {@code false}
*/
public void setEnableHeader(boolean enableHeader) {
this.enableHeader = enableHeader;
}
/**
* Returns whether the header is always required.
* @return {@code true} if header is always required, otherwise {@code false} (default: false)
* @since 0.7.3
*/
public boolean isForceHeader() {
return forceHeader;
}
/**
* Sets whether the header is always required.
* @param forceHeader {@code true} to always require header, otherwise {@code false}
* @since 0.7.3
*/
public void setForceHeader(boolean forceHeader) {
this.forceHeader = forceHeader;
}
/**
* Returns the {@code "true"} representation.
* @return the representation (default: {@link CsvConfiguration#DEFAULT_TRUE_FORMAT})
*/
public String getTrueFormat() {
return trueFormat;
}
/**
* Configures the {@code "true"} representation.
* @param format the representation
*/
public void setTrueFormat(String format) {
this.trueFormat = format;
}
/**
* Returns the {@code "false"} representation.
* @return the representation (default: {@link CsvConfiguration#DEFAULT_FALSE_FORMAT})
*/
public String getFalseFormat() {
return falseFormat;
}
/**
* Configures the {@code "false"} representation.
* @param format the representation
*/
public void setFalseFormat(String format) {
this.falseFormat = format;
}
/**
* Returns the {@link Date} representation in {@link SimpleDateFormat}.
* @return the representation (default: {@link CsvConfiguration#DEFAULT_DATE_FORMAT})
*/
public String getDateFormat() {
return dateFormat;
}
/**
* Configures the {@link Date} representation.
* @param format the representation in {@link SimpleDateFormat}
*/
public void setDateFormat(String format) {
this.dateFormat = format;
}
/**
* Returns the {@link DateTime} representation in {@link SimpleDateFormat}.
* @return the representation (default: {@link CsvConfiguration#DEFAULT_DATE_TIME_FORMAT})
*/
public String getDateTimeFormat() {
return dateTimeFormat;
}
/**
* Configures the {@link DateTime} representation.
* @param format the representation in {@link SimpleDateFormat}
*/
public void setDateTimeFormat(String format) {
this.dateTimeFormat = format;
}
/**
* Returns whether each value can contain linefeed.
* @return {@code true} if allowed, otherwise {@code false}
*/
public boolean isAllowLinefeed() {
return allowLinefeed;
}
/**
* Sets whether each value can contain linefeed.
* @param allow {@code true} if allowed, otherwise {@code false}
*/
public void setAllowLinefeed(boolean allow) {
this.allowLinefeed = allow;
}
/**
* Returns the codec name.
* @return the codec name, or {@code null} if no codecs are specified
* @since 0.5.2
*/
public String getCodecName() {
return codecName;
}
/**
* Sets the codec name.
* @param codecName the codec name, or {@code null} to reset it
* @since 0.5.2
*/
public void setCodecName(String codecName) {
this.codecName = codecName;
}
}
}