org.beanio.parser.fixedlength.FixedLengthFieldDefinition Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of beanio Show documentation

The BeanIO Project

There is a newer version: 2.1.0

/*
 * Copyright 2010-2011 Kevin Seim
 * 
 * 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.beanio.parser.fixedlength;

import org.beanio.parser.Record;
import org.beanio.parser.flat.FlatFieldDefinition;

/**
 * A FixedLengthFieldDefinition is used to parse and format fields for
 * fixed length records.
 * 
 * @author Kevin Seim
 * @since 1.0
 */
public class FixedLengthFieldDefinition extends FlatFieldDefinition {
    
    private String paddedNullText = "";
    
    @Override
    public boolean matches(Record record) {     
        if (!isRecordIdentifier()) {
            return true;
        }
        
        String text = getFieldText(record);
        if (text.length() != getLength()) {
            return false;
        }
        else {
            return isMatch(unpad(text));
        }
    }

    @Override
    protected String parseField(Record record) {
        String fieldText = getFieldText(record);
        record.setFieldText(getName(), fieldText);

        if (fieldText == null) {
            return null;
        }
        else if (fieldText.length() != getLength()) {
            record.addFieldError(getName(), fieldText, "length", getLength());
            return INVALID;
        }
        // return null if the field is all spaces, to allow for optional
        // zero padded fields
        else if (!Character.class.equals(getPropertyType()) && fieldText.trim().length() == 0) {
            return "";
        }
        else {
            return unpad(fieldText);
        }
    }
    
    /**
     * Overridden to return spaces filled to the padded length of the field.
     */
    @Override
    protected String formatPaddedNull() {
        return paddedNullText;
    }

    @Override
    public void setPaddedLength(int length) {
        super.setPaddedLength(length);
        
        if (length > 0) {
            StringBuilder s = new StringBuilder(length);
            for (int i=0; i