com.fluxtion.ext.text.api.csv.RowProcessor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fluxtion-text-api Show documentation

There is a newer version: 2.10.50

/* 
 * Copyright (C) 2018 V12 Technology Ltd.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the Server Side Public License, version 1,
 * as published by MongoDB, Inc.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * Server Side Public License for more details.
 *
 * You should have received a copy of the Server Side Public License
 * along with this program.  If not, see 
 * .
 */
package com.fluxtion.ext.text.api.csv;

import com.fluxtion.ext.streaming.api.Wrapper;
import com.fluxtion.ext.text.api.event.CharEvent;
import com.fluxtion.ext.text.api.event.EofEvent;
import java.io.IOException;
import java.util.Collection;

/**
 * Interface implemented by nodes processing delimited or fixed length records
 * into structured data.
 *
 * @author gregp
 * @param  The target type of the processor
 */
public interface RowProcessor extends Wrapper {

    /**
     * Indicates whether the row passed the validator attached to the target
     * type. A target type can annotate a method
     * @OnEvent a boolean return type indicates whether this is a
     * validating method.
     *
     * @return validation was successful, true indicates success. This value is
     * transient only returns true for the event cycle that a successful
     * validation has occurred.
     */
    boolean passedValidation();
    
    
    default int getRowNumber() {
        return -1;
    }
    
    boolean charEvent(CharEvent event);
    
    boolean eof(EofEvent eof);
    
    void init();
    
    void setErrorLog(ValidationLogger errorLog);
    
    default String csvHeaders() {return "";}

    default Appendable toCsv(T src, Appendable target) throws IOException {
        return target;
    }
    
    default Appendable toCsv(Collection src, Appendable target) throws IOException {
        return target;
    }    

}