/*
Copyright 2013 Nationale-Nederlanden
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package nl.nn.adapterframework.batch;
import java.util.Map;
import nl.nn.adapterframework.configuration.ConfigurationException;
import nl.nn.adapterframework.util.LogUtil;
import org.apache.commons.lang.StringUtils;
import org.apache.log4j.Logger;
/**
* The flow contains the handlers to handle records of a specific type.
* Each flow is registered to a manager using the recordHandlerManagerRef.
*
* <p><b>Configuration:</b>
* <table border="1">
* <tr><th>attributes</th><th>description</th><th>default</th></tr>
* <tr><td>classname</td><td>nl.nn.adapterframework.batch.RecordHandlingFlow</td><td> </td></tr>
* <tr><td>{@link #setRecordHandlerManagerRef(String) recordHandlerManagerRef}</td><td>Name of the manager to which this RecordHandlingFlow must be added</td><td> </td></tr>
* <tr><td>{@link #setRecordKey(String) recordKey}</td><td>Key under which this RecordHandlingFlow must be registered in the manager</td><td> </td></tr>
* <tr><td>{@link #setRecordHandlerRef(String) recordHandlerRef}</td><td>Name of the recordhandler to be used to transform records of the type specified in the key (optional)</td><td> </td></tr>
* <tr><td>{@link #setResultHandlerRef(String) resultHandlerRef}</td><td>Name of the resulthandler to be used to handle the transformed result</td><td> </td></tr>
* <tr><td>{@link #setNextRecordHandlerManagerRef(String) nextRecordHandlerManagerRef}</td><td>Name of the manager to be used after handling this record</td><td> </td></tr>
* <tr><td>{@link #setOpenBlockBeforeLine(String) openBlockBeforeLine}</td><td>instructs the resultHandler to start a new block before the parsed line is processed</td><td> </td></tr>
* <tr><td>{@link #setOpenBlockBeforeLineNumber(int) openBlockBeforeLineNumber}</td><td>when >0 the <code>openBlockBeforeLine</code> instruction is only performed when the current line number is a multiple of this value</td><td>0</td></tr>
* <tr><td>{@link #setCloseBlockBeforeLine(String) closeBlockBeforeLine}</td><td>instructs the resultHandler to end the specified block before the parsed line is processed</td><td> </td></tr>
* <tr><td>{@link #setOpenBlockAfterLine(String) openBlockAfterLine}</td><td>instructs the resultHandler to start a new block after the parsed line is processed</td><td> </td></tr>
* <tr><td>{@link #setCloseBlockAfterLine(String) closeBlockAfterLine}</td><td>instructs the resultHandler to end the specified block after the parsed line is processed</td><td> </td></tr>
* <tr><td>{@link #setAutoCloseBlock(boolean) autoCloseBlock}</td><td>when <code>true</code>, any open block of this type (and other nested open 'autoclose' block) is closed before a new one of the same type is opened. At a forced close, nested blocks are closed too (since 4.9)</td><td><code>true</code></td></tr>
* </table>
* </p>
*
* @author John Dekker
*/
public final class RecordHandlingFlow {
protected Logger log = LogUtil.getLogger(this);
private String recordKey;
private String recordHandlerRef;
private String recordHandlerManagerRef;
private String nextRecordHandlerManagerRef;
private String resultHandlerRef;
private String openBlockBeforeLine=null;
private String closeBlockBeforeLine=null;
private String openBlockAfterLine=null;
private String closeBlockAfterLine=null;
private boolean autoCloseBlock=true;
private int openBlockBeforeLineNumber=0;
private IRecordHandler recordHandler;
private IRecordHandlerManager nextRecordHandlerManager;
private IResultHandler resultHandler;
public void configure(IRecordHandlerManager manager, Map registeredManagers, Map registeredRecordHandlers, Map registeredResultHandlers, IResultHandler defaultHandler) throws ConfigurationException {
if (getOpenBlockBeforeLineNumber()>0 && StringUtils.isEmpty(getOpenBlockBeforeLine())) {
throw new ConfigurationException("openBlockBeforeLine must be set when openBlockBeforeLineNumber > 0");
}
if (StringUtils.isNotEmpty(getRecordHandlerManagerRef()) &&
!getRecordHandlerManagerRef().equals(manager.getName())) {
throw new ConfigurationException("recordHandlerManagerRef ["+getRecordHandlerManagerRef()+"] should be either equal to name of manager ["+manager.getName()+"], or left unspecified");
}
// obtain the named manager that is to be used after a specified record
IRecordHandlerManager nextManager = null;
if (StringUtils.isEmpty(getNextRecordHandlerManagerRef())) {
nextManager = manager;
} else {
nextManager = (IRecordHandlerManager)registeredManagers.get(getNextRecordHandlerManagerRef());
if (nextManager == null) {
throw new ConfigurationException("cannot find nextRecordHandlerManager [" + getNextRecordHandlerManagerRef() + "] for flow of manager [" + getNextRecordHandlerManagerRef() + "], key ["+getRecordKey()+"]");
}
}
setNextRecordHandlerManager(nextManager);
// obtain the recordhandler
if (StringUtils.isNotEmpty(getRecordHandlerRef())) {
IRecordHandler recordHandler = (IRecordHandler)registeredRecordHandlers.get(getRecordHandlerRef());
if (recordHandler!=null) {
setRecordHandler(recordHandler);
} else {
throw new ConfigurationException("cannot find recordhandler ["+getRecordHandlerRef()+"] for flow of manager [" + getNextRecordHandlerManagerRef() + "], key ["+getRecordKey()+"]");
}
} else {
log.debug("no recordhandler defined for flow of manager [" + getNextRecordHandlerManagerRef() + "], key ["+getRecordKey()+"]");
}
// obtain the named resulthandler
IResultHandler resultHandler = (IResultHandler)registeredResultHandlers.get(getResultHandlerRef());
if (resultHandler == null) {
if (StringUtils.isEmpty(getResultHandlerRef())) {
resultHandler = defaultHandler;
} else {
throw new ConfigurationException("ResultHandler [" + getResultHandlerRef() + "] not found");
}
}
setResultHandler(resultHandler);
}
public void setRecordHandler(IRecordHandler handler) {
recordHandler = handler;
}
public IRecordHandler getRecordHandler() {
return recordHandler;
}
public void setResultHandler(IResultHandler handler) {
resultHandler = handler;
}
public IResultHandler getResultHandler() {
return resultHandler;
}
public void setNextRecordHandlerManager(IRecordHandlerManager manager) {
nextRecordHandlerManager = manager;
}
public IRecordHandlerManager getNextRecordHandlerManager() {
return nextRecordHandlerManager;
}
public void setRecordKey(String recordKey) {
this.recordKey = recordKey;
}
public String getRecordKey() {
return recordKey;
}
public void setNextRecordHandlerManagerRef(String nextRecordHandlerManagerName) {
nextRecordHandlerManagerRef = nextRecordHandlerManagerName;
}
public String getNextRecordHandlerManagerRef() {
return nextRecordHandlerManagerRef;
}
public void setRecordHandlerRef(String recordHandlerName) {
recordHandlerRef = recordHandlerName;
}
public String getRecordHandlerRef() {
return recordHandlerRef;
}
public void setRecordHandlerManagerRef(String recordHandlerManagerName) {
recordHandlerManagerRef = recordHandlerManagerName;
}
public String getRecordHandlerManagerRef() {
return recordHandlerManagerRef;
}
public void setResultHandlerRef(String resultHandlerName) {
resultHandlerRef = resultHandlerName;
}
public String getResultHandlerRef() {
return resultHandlerRef;
}
public void setOpenBlockBeforeLine(String blockName) {
openBlockBeforeLine = blockName;
}
public String getOpenBlockBeforeLine() {
return openBlockBeforeLine;
}
public void setCloseBlockBeforeLine(String blockName) {
closeBlockBeforeLine = blockName;
}
public String getCloseBlockBeforeLine() {
return closeBlockBeforeLine;
}
public void setOpenBlockAfterLine(String blockName) {
openBlockAfterLine = blockName;
}
public String getOpenBlockAfterLine() {
return openBlockAfterLine;
}
public void setCloseBlockAfterLine(String blockName) {
closeBlockAfterLine = blockName;
}
public String getCloseBlockAfterLine() {
return closeBlockAfterLine;
}
public void setAutoCloseBlock(boolean b) {
autoCloseBlock = b;
}
public boolean isAutoCloseBlock() {
return autoCloseBlock;
}
public void setOpenBlockBeforeLineNumber(int i) {
openBlockBeforeLineNumber = i;
}
public int getOpenBlockBeforeLineNumber() {
return openBlockBeforeLineNumber;
}
}