• Home
• com.reprezen.genflow
• genflow-api
• 1.0.0
• source code
• package-info.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.reprezen.genflow.api.outputitem.package-info Maven / Gradle / Ivy

/*******************************************************************************
 * Copyright © 2013, 2016 Modelsolv, Inc.
 * All Rights Reserved.
 *
 * NOTICE: All information contained herein is, and remains the property
 * of ModelSolv, Inc. See the file license.html in the root directory of
 * this project for further information.
 *******************************************************************************/
/**
 * This package provides support for Output Items, which are used by
 * GenTemplates that extend
 * {@link com.reprezen.genflow.api.template.GenTemplate} to create genereated
 * output files.
 * 

 * An output item is responsible for producing the content of an output file,
 * given an item of source data, plus a set of named string-valued parameters
 * appearing in the controlling GenTarget. The input item is supplied as a pair
 * of values: the overall source value loaded by the GenTemplate's primary
 * source, and an item value obtained from that source value by an extraction
 * method of {@link com.reprezen.genflow.api.source.ISource}.
 * 

 * Classes in this package include:
 * 

 * 
{@link IOutputItem}
 * 
Defines the interface for an output item. This is a generic interface
 * with type parameters for the source and item value types. An output item
 * intended to work on the source value as whole will specify the source value
 * type for both types.
 * 

 * An output item must be initialized via {@link outputitem.IOutputItem#init()}
 * before being used to generate output. This is used to provide both a
 * {@link com.reprezen.genflow.api.trace.GenTemplateTraceBuilder} and a
 * {@link com.reprezen.genflow.api.trace.GenTemplateTraces} object for use
 * during generation. The former allows the output item to create trace
 * information as it executes, while the latter provides access to trace
 * information from prerequisite GenTargets.
 * 
{@link AbstractOutputItem}
 * 
Provides default implementations for some methods
 * 
 * 
 * @author Andy Lowry
 *
 */
package com.reprezen.genflow.api.outputitem;