ConverterBase (PLANitAllJavaOnly 0.4.0 API)

java.lang.Object
- org.goplanit.converter.ConverterBase

Direct Known Subclasses:

Converter, PairConverter
```
public abstract class ConverterBase
extends Object
```
Base converter for PLANit entities

Author:

markr

Constructor Summary

Constructors
Modifier Constructor Description

protected ConverterBase(ConverterEntity reader, ConverterEntity writer)
constructor

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract void`	`convert()`	Convert the reader's content and pass it on to the writer to convert it.
`protected ConverterEntity`	`getReader()`	get the reader
`protected ConverterEntity`	`getWriter()`	get the writer

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ConverterBase
```
protected ConverterBase(ConverterEntity reader,
                        ConverterEntity writer)
```
    constructor
    
    Parameters:
    
    reader - to use for parsing
    
    writer - to use for persisting
- Method Detail
  - getReader
```
protected ConverterEntity getReader()
```
    get the reader
    
    Returns:
    
    the reader
  - getWriter
```
protected ConverterEntity getWriter()
```
    get the writer
    
    Returns:
    
    the writer
  - convert
```
public abstract void convert()
                      throws PlanItException
```
    Convert the reader's content and pass it on to the writer to convert it. It is assumed both reader and writer are fully configured when this method is called
    
    Throws:
    
    PlanItException - thrown if error