org.databene.benerator.Consumer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of databene-benerator Show documentation

benerator is a framework for creating realistic and valid high-volume test data, used for testing (unit/integration/load) and showcase setup. Metadata constraints are imported from systems and/or configuration files. Data can imported from and exported to files and systems, anonymized or generated from scratch. Domain packages provide reusable generators for creating domain-specific data as names and addresses internationalizable in language and region. It is strongly customizable with plugins and configuration options.

The newest version!

/*
 * (c) Copyright 2008-2013 by Volker Bergmann. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, is permitted under the terms of the
 * GNU General Public License.
 *
 * For redistributing this software or a derivative work under a license other
 * than the GPL-compatible Free Software License as defined by the Free
 * Software Foundation or approved by OSI, you must first obtain a commercial
 * license to this software product from Volker Bergmann.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * WITHOUT A WARRANTY OF ANY KIND. ALL EXPRESS OR IMPLIED CONDITIONS,
 * REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE
 * HEREBY EXCLUDED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

package org.databene.benerator;

import java.io.Closeable;
import java.io.Flushable;

import org.databene.benerator.wrapper.ProductWrapper;

/**
 * Abstraction of an object that consumes (possibly larger quantities of) objects.
 * Consumation is a two-step process: For each object A to be consumed, Benerator 
 * first calls {@link #startConsuming(ProductWrapper)}, then 
 * {@link #finishConsuming(ProductWrapper)} with a wrapper of this object: 
 *  * 	startConsuming(A);
 * 	finishConsuming(A);
 * 
 * If an object A has a 'sub object' B, (defined via nested a >generate< 
 * statement), Benerator represents the recursion by the following invocation sequence:
 *  * 	startConsuming(A);
 * 	startConsuming(B);
 * 	finishConsuming(B);
 * 	finishConsuming(A);
 * 
 * 

 * Created: 01.02.2008 16:15:09
 * @since 0.4.0
 * @author Volker Bergmann
 */
public interface Consumer extends Flushable, Closeable {
	
	/** Starts consumption of an object. For invocation details see the class documentation. */
    void startConsuming(ProductWrapper wrapper);
    
	/** Starts consumption of an object. For invocation details see the class documentation. */
    void finishConsuming(ProductWrapper wrapper);
    
    /** Is called by Benerator for advising the Consumer to finish processing of the objects 
     *  consumed so far. In Benerator descriptor files, the flushing behavior is controlled 
     *  by the pageSize attribute. */
    @Override
	void flush();
    
    /** When called, the implementor has to close and free all resources. 
     * It will not receive any more calls. */
    @Override
	void close();
    
}