com.github.vicenthy.filehelpers4j.masterdetail.MasterDetailEngine Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of FileHelpers4J Show documentation
FileHelpers4J is a library that automates the tedious task of parsing and creating structured text files. It handles fixed width or delimited files with Java annotations sweetness
The newest version!
/*
 * MasterDetailEngine.java
 *
 * Copyright (C) 2007 Atila Augusto dos Santos - 
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */
package com.github.vicenthy.filehelpers4j.masterdetail;

import java.io.BufferedReader;
import java.io.BufferedWriter;
import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.FileReader;
import java.io.FileWriter;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.OutputStreamWriter;
import java.util.ArrayList;
import java.util.List;

import com.github.vicenthy.filehelpers4j.core.ForwardReader;
import com.github.vicenthy.filehelpers4j.core.RecordInfo;
import com.github.vicenthy.filehelpers4j.engines.EngineBase;
import com.github.vicenthy.filehelpers4j.engines.LineInfo;
import com.github.vicenthy.filehelpers4j.helpers.ProgressHelper;
import com.github.vicenthy.filehelpers4j.helpers.StringHelper;


public class MasterDetailEngine extends EngineBase {

	@SuppressWarnings("unused")
	private Class masterRecordClass;
	private final RecordInfo masterInfo;
	private final RecordActionSelector recordSelector;

	public MasterDetailEngine(Class masterRecordClass, Class
 detailRecordClass, RecordActionSelector recordSelector) {
		super(detailRecordClass);
		this.masterRecordClass = masterRecordClass;
		this.masterInfo = new RecordInfo(masterRecordClass);
		this.recordSelector = recordSelector;
	}
	
	public MasterDetailEngine(Class masterRecordClass, Class
 detailRecordClass, CommonSelector action, String selector) {
		super(detailRecordClass);
		this.masterInfo = new RecordInfo(masterRecordClass);
		final CommonInternalSelector sel = new CommonInternalSelector(action, selector, masterInfo.isIgnoreEmptyLines() || recordInfo.isIgnoreEmptyLines());
		
		this.recordSelector = new RecordActionSelector() {
			@Override
			public RecordAction getRecordAction(String recordString) {
				return sel.getCommonSelectorMethod(recordString);			
			}
			
		};
	}
	
	public List> readResource(String fileName) throws IOException {
		List> tempRes = null;		
		
		InputStreamReader fr = null;
		try {
			fr = new InputStreamReader(getClass().getResourceAsStream(fileName));
			tempRes = readStream(fr);
		}
		finally {
			if (fr != null) {
				fr.close();
			}
		}
		
		return tempRes;
	}
	
	public List> fromString(String s) throws IOException {
		return readStream(new InputStreamReader(new ByteArrayInputStream(s.getBytes())));
	}
	
	public List> readFile(String fileName) throws IOException {
		List> tempRes = null;
		
		FileReader fr = null;
		try {
			fr = new FileReader(new File(fileName));
			tempRes = readStream(fr);
		}
		finally {
			if (fr != null) {
				fr.close();
			}
		}
		
		return tempRes;
	}

	public void writeFile(String fileName, MasterDetails record) throws IOException {
		List> list = new ArrayList>();
		list.add(record);
		
		writeFile(fileName, list);
	}

	public void writeFile(String fileName, List> records) throws IOException {
		writeFile(fileName, records, -1);
	}
	
	public void writeFile(String fileName, List> records, int maxRecords) throws IOException {
		FileWriter fw = null;
		try {
			fw = new FileWriter(new File(fileName));
			//fw.write("ABCDEF\n");
			writeStream(fw, records, maxRecords);
		}
		finally {
			if (fw != null) {
				fw.flush();
				fw.close();
			}
		}
	}
	
	private void writeStream(OutputStreamWriter osr, List> records, int maxRecords) throws IOException {
		BufferedWriter writer = new BufferedWriter(osr);
		
		resetFields();
		if (getHeaderText() != null && getHeaderText().length() != 0) {
			writer.write(getHeaderText());
			if (!getHeaderText().endsWith(StringHelper.NEW_LINE)) {
				writer.write(StringHelper.NEW_LINE);
			}
		}

		String currentLine = null;

		int max = records.size();

		if (maxRecords >= 0) {
			max = Math.min(max, maxRecords);
		}

		ProgressHelper.notify(notifyHandler, progressMode, 0, max);

		for (int i = 0; i < max; i++) {
			try {
				if (records.get(i) == null) {
					throw new IllegalArgumentException("The record at index " + i + " is null.");
				}
				
				ProgressHelper.notify(notifyHandler, progressMode, i+1, max);

				currentLine = masterInfo.recordToStr(records.get(i).getMaster());
				writer.write(currentLine + StringHelper.NEW_LINE);

				if (records.get(i).getDetails() != null) { 
					for (int d = 0; d < records.get(i).getDetails().size(); d++) {
						currentLine = recordInfo.recordToStr(records.get(i).getDetails().get(d));
						writer.write(currentLine + StringHelper.NEW_LINE);
					}
				}

				writer.flush();
			}
			catch (Exception ex) {
				ex.printStackTrace();
				// TODO error manager
//				switch (mErrorManager.ErrorMode)
//				{
//					case ErrorMode.ThrowException:
//						throw;
//					case ErrorMode.IgnoreAndContinue:
//						break;
//					case ErrorMode.SaveAndContinue:
//						ErrorInfo err = new ErrorInfo();
//						err.mLineNumber = mLineNumber;
//						err.mExceptionInfo = ex;
////						err.mColumnNumber = mColumnNum;
//						err.mRecordString = currentLine;
//						mErrorManager.AddError(err);
//						break;
//				}
			}
		}

		totalRecords = records.size();

		if (getFooterText() != null && getFooterText() != "") {
			writer.write(getFooterText());
			if (!getFooterText().endsWith(StringHelper.NEW_LINE)) {
				writer.write(StringHelper.NEW_LINE);
			}
		}		
	}
		
	private List> readStream(InputStreamReader fileReader) throws IOException {
		BufferedReader reader = new BufferedReader(fileReader);

		resetFields();
		setHeaderText("");
		setFooterText("");
		
		List> resArray = new ArrayList>();
		
		ForwardReader freader = new ForwardReader(reader, masterInfo.getIgnoreLast());
		freader.setDiscardForward(true);

		String currentLine, completeLine;

		lineNumber = 1;

		completeLine = freader.readNextLine();
		currentLine = completeLine;

		ProgressHelper.notify(notifyHandler, progressMode, 0, -1);
		
		int currentRecord = 0;

		if (masterInfo.getIgnoreFirst() > 0) {
			for (int i = 0; i < masterInfo.getIgnoreFirst() && currentLine != null; i++) {
				headerText += currentLine + StringHelper.NEW_LINE;
				currentLine = freader.readNextLine();
				lineNumber++;
			}
		}

		boolean byPass = false;
		MasterDetails record = null;
		
		List
 tmpDetails = new ArrayList();

		LineInfo line = new LineInfo(currentLine);
		line.setReader(freader);
		
		while (currentLine != null) {
			try
			{
				currentRecord++; 

				line.reload(currentLine);
				
				ProgressHelper.notify(notifyHandler, progressMode, currentRecord, -1);

				RecordAction action = recordSelector.getRecordAction(currentLine);
				switch (action) {
					case Master:
						if (record != null) {							
							record.addDetails(tmpDetails);
							resArray.add(record);
						}

						totalRecords++;
						record = new MasterDetails();
						tmpDetails.clear();
						
						MT lastMaster = masterInfo.strToRecord(line);

						if (lastMaster != null) {
							record.setMaster(lastMaster);
						}

						break;

					case Detail:
						DT lastChild = recordInfo.strToRecord(line);

						if (lastChild != null) {
							tmpDetails.add(lastChild);
						}
						break;

					default:
						break;
				}
			}
			catch (Exception ex) {
				// TODO error handling
				ex.printStackTrace();
//				switch (mErrorManager.ErrorMode)
//				{
//					case ErrorMode.ThrowException:
//						byPass = true;
//						throw;
//					case ErrorMode.IgnoreAndContinue:
//						break;
//					case ErrorMode.SaveAndContinue:
//						ErrorInfo err = new ErrorInfo();
//						err.mLineNumber = mLineNumber;
//						err.mExceptionInfo = ex;
////						err.mColumnNumber = mColumnNum;
//						err.mRecordString = completeLine;
//
//						mErrorManager.AddError(err);
//						break;
//				}
			}
			finally
			{
				if (byPass == false) {
					currentLine = freader.readNextLine();
					completeLine = currentLine;
					lineNumber = freader.getLineNumber();
				}
			}

		}

		if (record != null) {
			record.addDetails(tmpDetails);
			resArray.add(record);
		}

		if (masterInfo.getIgnoreLast() > 0) {
			footerText = freader.getRemainingText();
		}

		return resArray;		
	}

	class CommonInternalSelector {
		
		private final String selector;
		private final boolean ignoreEmpty;
		private final CommonSelector action;
		
		public CommonInternalSelector(CommonSelector action, String selector, boolean ignoreEmpty) {
			this.action = action;
			this.selector = selector;
			this.ignoreEmpty = ignoreEmpty;
		}
		
		protected RecordAction getCommonSelectorMethod(String recordString) {
			if (ignoreEmpty && recordString.length() < 1) {
				return RecordAction.Skip;
			}

			switch (action) {
			case DetailIfContains:
				if (recordString.indexOf(selector) >= 0)
					return RecordAction.Detail;
				else
					return RecordAction.Master;

			case MasterIfContains:
				if (recordString.indexOf(selector) >= 0)
					return RecordAction.Master;
				else
					return RecordAction.Detail;

			case DetailIfBegins:
				if (recordString.startsWith(selector))
					return RecordAction.Detail;
				else
					return RecordAction.Master;
			
			case MasterIfBegins:
				if (recordString.startsWith(selector))
					return RecordAction.Master;
				else
					return RecordAction.Detail;

			case DetailIfEnds:
				if (recordString.endsWith(selector))
					return RecordAction.Detail;
				else
					return RecordAction.Master;

			case MasterIfEnds:
				if (recordString.endsWith(selector))
					return RecordAction.Master;
				else
					return RecordAction.Detail;

			case DetailIfEnclosed:
				if (recordString.startsWith(selector) && recordString.endsWith(selector))
					return RecordAction.Detail;
				else
					return RecordAction.Master;

			case MasterIfEnclosed:
				if (recordString.startsWith(selector) && recordString.endsWith(selector))
					return RecordAction.Master;
				else
					return RecordAction.Detail;
			}

			return RecordAction.Skip;
		}
		
	}
}