com.asakusafw.runtime.io

Class ModelIoFactory<T>

java.lang.Object

com.asakusafw.runtime.io.ModelIoFactory<T>

Type Parameters:

T - the target data model type

Direct Known Subclasses:

TsvIoFactory

public abstract class ModelIoFactory<T>
extends Object

An abstract super class of reading/writing data model objects.

Since:

0.1.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	MODEL_INPUT_CLASS_FORMAT Deprecated. Use ModelInputLocation to specify ModelInput instead
static String	MODEL_OUTPUT_CLASS_FORMAT Deprecated. Use ModelOutputLocation to specify ModelOutput instead

Constructor Summary

Constructors

Constructor and Description
ModelIoFactory(Class<T> modelClass) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
ModelInput<T>	createModelInput(InputStream in) Creates a new ModelInput for the target InputStream.
ModelInput<T>	createModelInput(RecordParser parser) Creates a new ModelInput for the target RecordParser.
T	createModelObject() Creates a new data model object.
ModelOutput<T>	createModelOutput(OutputStream out) Creates a new ModelOutput for the target OutputStream.
ModelOutput<T>	createModelOutput(RecordEmitter emitter) Creates a new ModelOutput for the target RecordEmitter.
protected abstract RecordEmitter	createRecordEmitter(OutputStream out) Creates a new default RecordEmitter.
protected abstract RecordParser	createRecordParser(InputStream in) Creates a new default RecordParser.
protected Class<?>	findModelInputClass() Returns the ModelInput class for this factory.
protected Class<?>	findModelOutputClass() Returns the ModelOutput class for this factory.
protected Class<T>	getModelClass() Returns the target data model class.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MODEL_INPUT_CLASS_FORMAT

@Deprecated
public static final String MODEL_INPUT_CLASS_FORMAT

Deprecated. Use ModelInputLocation to specify ModelInput instead

The qualified name pattern of ModelInput in MessageFormat.

• {0} - base package name
• {1} - simple class name

See Also:

Constant Field Values

MODEL_OUTPUT_CLASS_FORMAT

@Deprecated
public static final String MODEL_OUTPUT_CLASS_FORMAT

Deprecated. Use ModelOutputLocation to specify ModelOutput instead

The qualified name pattern of ModelOutput in MessageFormat.

• {0} - base package name
• {1} - simple class name

See Also:

Constant Field Values

Constructor Detail

ModelIoFactory

public ModelIoFactory(Class<T> modelClass)

Creates a new instance.

Parameters:

modelClass - the data model class

Throws:

IllegalArgumentException - if the parameter is null

Method Detail

getModelClass

protected Class<T> getModelClass()

Returns the target data model class.

Returns:

the target data model class

createModelObject

public T createModelObject()
                    throws IOException

Creates a new data model object.

Returns:

the created object

Throws:

IOException - if failed to create a new object

createModelInput

public ModelInput<T> createModelInput(InputStream in)
                               throws IOException

Creates a new ModelInput for the target InputStream.

Parameters:

in - an input stream that provides serialized data model objects

Returns:

the created instance

Throws:

IOException - if failed to initialize the ModelInput

IllegalArgumentException - if the parameter is null

createModelInput

public ModelInput<T> createModelInput(RecordParser parser)
                               throws IOException

Creates a new ModelInput for the target RecordParser.

Parameters:

parser - a parser that provides records of data model objects

Returns:

the created instance

Throws:

IOException - if failed to initialize the ModelInput

IllegalArgumentException - if the parameter is null

createModelOutput

public ModelOutput<T> createModelOutput(OutputStream out)
                                 throws IOException

Creates a new ModelOutput for the target OutputStream.

Parameters:

out - an output stream that accepts serialized data model objects

Returns:

the created instance

Throws:

IOException - if failed to initialize the ModelOutput

IllegalArgumentException - if the parameter is null

createModelOutput

public ModelOutput<T> createModelOutput(RecordEmitter emitter)
                                 throws IOException

Creates a new ModelOutput for the target RecordEmitter.

Parameters:

emitter - an emitter that accepts data model objects

Returns:

the created instance

Throws:

IOException - if failed to initialize the ModelOutput

IllegalArgumentException - if the parameter is null

createRecordParser

protected abstract RecordParser createRecordParser(InputStream in)
                                            throws IOException

Creates a new default RecordParser.

Parameters:

in - the source input

Returns:

the created object

Throws:

IOException - if failed to initialize the parser

IllegalArgumentException - if the parameter is null

createRecordEmitter

protected abstract RecordEmitter createRecordEmitter(OutputStream out)
                                              throws IOException

Creates a new default RecordEmitter.

Parameters:

out - the target output

Returns:

the created object

Throws:

IOException - if failed to initialize the emitter

IllegalArgumentException - if the parameter null

findModelInputClass

protected Class<?> findModelInputClass()
                                throws ClassNotFoundException

Returns the ModelInput class for this factory.

Returns:

the ModelInput class

Throws:

ClassNotFoundException - if the target class is not found

See Also:

ModelInputLocation

findModelOutputClass

protected Class<?> findModelOutputClass()
                                 throws ClassNotFoundException

Returns the ModelOutput class for this factory.

Returns:

the ModelOutput class

Throws:

ClassNotFoundException - if the target class is not found

See Also:

ModelInputLocation