From 6a590dba92724f57891827377a4ca414521fdbec Mon Sep 17 00:00:00 2001 From: gumartinm Date: Thu, 12 Jul 2012 01:39:24 +0200 Subject: [PATCH] Removing useless class. --- .../src/printer/helper/PrinterLogicalHelper.java | 430 --------------------- 1 file changed, 430 deletions(-) delete mode 100755 Allgemeines/PrinterHelper/src/printer/helper/PrinterLogicalHelper.java diff --git a/Allgemeines/PrinterHelper/src/printer/helper/PrinterLogicalHelper.java b/Allgemeines/PrinterHelper/src/printer/helper/PrinterLogicalHelper.java deleted file mode 100755 index 7d987d7..0000000 --- a/Allgemeines/PrinterHelper/src/printer/helper/PrinterLogicalHelper.java +++ /dev/null @@ -1,430 +0,0 @@ -package de.printer.helper; - -import java.io.BufferedReader; -import java.io.ByteArrayOutputStream; -import java.io.File; -import java.io.FileInputStream; -import java.io.FileNotFoundException; -import java.io.FileOutputStream; -import java.io.FilenameFilter; -import java.io.IOException; -import java.io.InputStreamReader; -import java.io.OutputStream; -import java.io.PrintStream; -import java.io.UnsupportedEncodingException; -import java.util.ArrayList; -import java.util.List; -import java.util.ListIterator; -import org.apache.log4j.Logger; - - -/** - *

- * First of all some thoughts: - *

- *

- * The device wrapper classes lack methods for changing themselves the device configuration. - * These methods can be found in the Logical layer, so this layer is device-dependent - * (it just will work with JavaPOS devices) - * Actually we have two options in order to write specific methods related to the device - * configuration. We can add these methods to the Logical layer or create a new Helper Class - * for them but... What about if we need to add device specific methods? The Logical layer is right - * now JavaPOS dependent (although it was intended to be a device abstraction...) if we add - * device specific methods such as methods related to a specific kind of Printer, the Logical - * layer will be useless and the code will be a mess (if some day a device is changed we will - * have to search the whole code to find out what code is related with that device and - * we will have to create new classes in the Logical layer for every device ) - *

- *

- * So this Helper is intended to store methods which do not fit into the Logical layer because - * they make this layer not just JPOS dependent but completely device-dependent. All of this because - * of the wrapper classes lack the required methods for these kinds of operations. - *

- *

- * To sum up, before adding in this class new methods you should ask yourself two questions: - *

- *

- *

- * Instances of this class are mutable. To use them concurrently, clients must surround each - * method invocation (or invocation sequence) with external synchronization of the clients choosing. - *

- */ -public class PrinterLogicalHelper { - private static final Logger logger = Logger.getLogger(PrinterLogicalHelper.class); - private static final String FORM_PROPERTIES_FILE_RELATIVE_PATH = "etc/"+ FormConfiguration.PROPERTIES_FILE; - private static final String HOME_ENV_KEY = "HOME"; - private static final String TEMPLATE_FILE_EXTENSION = ".frm"; - private static final String PRINTER_PROPERTY = "MethodToPrintImage"; - private static final String PRINTER_PROPERTY_VALUE = "ESC/POS"; - private static final String PATTERN_TO_TM88V = "methodToPrintImage(ESC/POS)"; - private static final String PATTERN_FROM_TM88V = "usePageMode(false)"; - private static final String LINE_REPLACEMENT_TO_TM88V = " COMMENT \"usePageMode(false)\""; - private static final String LINE_REPLACEMENT_FROM_TM88V = " COMMENT \"usePageMode(false) methodToPrintImage(ESC/POS)\""; - - // Prevents instantiation from other classes. Why do you want to extend this class? - private PrinterLogicalHelper() { } - - - /** - * This method must try and fetch the model of the currently connected form printer (physically) - * on the given port - * - * @param formPrinterPort the printer port. - * @return the model printer as a {@link FormPrinterModel} class - * - */ - public final static FormPrinterModel autoDetetectFormPrinterModel(final Port formPrinterPort) - { - FormPrinterModel formPrinterModelDetected = null; - - final File scriptAutoDetect = new File(System.getProperty(HOME_ENV_KEY),"tools/detectatm88.sh"); - if (scriptAutoDetect.exists() && scriptAutoDetect.canExecute()){ - - - final ByteArrayOutputStream baos = new ByteArrayOutputStream(); - final PrintStream output = new PrintStream(baos); - - final String command = "sh " + scriptAutoDetect.getAbsolutePath() + " " + formPrinterPort.getPhysicalPath(); - try { - int result; - - //result field stores exit status of the executed command - result = LauncherProcesses.exec(command,output); - - if(result==0) - { - logger.debug("detectatm88 raw output: "+baos.toString()); - //From detectatm88.sh script we receive a string like this one: "RESULT: 2" - //we must split the String and retrieve the integer value - final String[] parameters = baos.toString().split(" "); - final int model = Integer.parseInt(parameters[1].trim()); - switch(model){ - case 0: - logger.warn("TM88 not physically detected: run again detectatm88.sh script"); - formPrinterModelDetected = null; - break; - case 2: - logger.info("TM-T88II detected"); - formPrinterModelDetected = FormPrinterModel.EPSON_TM_88_II_III; - break; - case 3: - logger.info("TM-T88III detected"); - formPrinterModelDetected = FormPrinterModel.EPSON_TM_88_II_III; - break; - case 4: - logger.info("TM-T88IV detected"); - formPrinterModelDetected = FormPrinterModel.EPSON_TM_88_IV; - break; - case 5: - logger.info("TM-T88V detected"); - formPrinterModelDetected = FormPrinterModel.EPSON_TM_88_V; - break; - default: - logger.warn("Code retrieved from detectatm88.sh script does not match."); - formPrinterModelDetected = null; - break; - } - } - //model not detected - else{ - logger.warn("TM88 not physically detected. Not conected printer or it is not a TM-T88"); - } - } catch (Exception e) { - logger.error(e); - } - } - else { - logger.warn("Script for tm88 detection not found or not exectuable"); - } - - return formPrinterModelDetected; - } - - /** - * This method is intended to add new properties in DtgFormToPrint.properties file used by TM88 printers. - * - * @param property the property to be added - * @param value value of property param. Possible values: - *
- * - * @throws FileNotFoundException if the file called DtgFormToPrint.properties - * is not found while writing or reading. - * @throws SecurityException if a security manager exists and its - * checkWrite method denies write access. - * @throws IOException while flushing or closing the DtgFormToPrint.properties file. - * @throws NullPointerException if property or value is null - */ - public final static void addFormPrinterProperty(final String property, - final String value) throws FileNotFoundException, IOException - { - if (property != null && value != null) { - //If the property does exist we do not have to add it again - if (FormConfiguration.getConfiguration().getSection().get(property) == null) - { - FormConfiguration.getConfiguration().getSection().add(property,value); - OutputStream dtgFormConfigurationFile; - dtgFormConfigurationFile = new FileOutputStream - (new File(System.getProperty(HOME_ENV_KEY),FORM_PROPERTIES_FILE_RELATIVE_PATH)); - FormConfiguration.getConfiguration().save(dtgFormConfigurationFile); - dtgFormConfigurationFile.flush(); - dtgFormConfigurationFile.close(); - - //We have to reload again the configuration. - FormConfiguration.reload(); - } - } - else { - throw new NullPointerException("Input parameters in addFormPrinterProperty: " + - "invalid null. Object is required. First parameter, property: " + - property + " Second parameter, value: " + value); - } - } - - /** - * This method is intended to remove properties in DtgFormToPrint.properties file used by TM88 printers. - * - * @param property property to be removed - * @throws FileNotFoundException if the file called DtgFormToPrint.properties is not found. - * @throws SecurityException if a security manager exists and its - * checkWrite method denies write access. - * @throws IOException while flushing or closing the DtgFormToPrint.properties file. - * @throws NullPointerException if property is null - */ - public final static void removeFormPrinterProperty(final String property) throws FileNotFoundException, IOException - { - if (property != null) { - //If the property does not exist we do not have to remove it - if (FormConfiguration.getConfiguration().getSection().get(property) != null) - { - FormConfiguration.getConfiguration().getSection().remove(property); - OutputStream dtgFormConfigurationFile; - dtgFormConfigurationFile = new FileOutputStream - (new File(System.getProperty(HOME_ENV_KEY),FORM_PROPERTIES_FILE_RELATIVE_PATH)); - FormConfiguration.getConfiguration().save(dtgFormConfigurationFile); - dtgFormConfigurationFile.flush(); - dtgFormConfigurationFile.close(); - - //We have to reload again the configuration. - FormConfiguration.reload(); - } - } - else { - throw new NullPointerException("Input parameter in removeFormPrinterProperty: " + - "invalid null. Object is required."); - } - } - - /** - * This method returns a {@code List} with the found files. - * - * @param extension the file extension name - * @return the found files - * @throws SecurityException if a security manager exists and its {@link - * java.lang.SecurityManager#checkRead(java.lang.String)} - * method denies read access to the directory - */ - public final static List findFilebyExtension(final String extension) - { - final File dir = ConfigurationHelper.getInstance().getFormsFolder(); - - final FilenameFilter filter = new FilenameFilter() { - public boolean accept(final File dir, final String name) { - return name.endsWith(extension); - } - }; - List filesList = new ArrayList(); - - for (File file : dir.listFiles(filter)) { - filesList.add(file); - } - - return filesList; - } - - /** - * Read file line by line and stores the lines in a {@link List} - *
- * This method is intended to be as fast as possible, so we are not checking - * the input parameters, it is under your responsability to pass the right - * values to this method. What basically means, you are not allowed to use null - * an Object is always required for every input parameter. Otherwise you can expect a - * nice exception or something worse. - * - * @param file - * @param charset the file charset - * @return the file lines in a {@link List} - * @throws FileNotFoundException if the file does not exist, is a directory - * rather than a regular file, or for some other reason cannot be opened for - * reading. - * @throws UnsupportedEncodingException if the named charset is not supported - * @throws SecurityException if a security manager exists and its - * checkRead method denies read access to the file. - * @throws IOException if an I/O error occurs while reading the file - */ - public final static List readFile (final File file, final String charset) - throws UnsupportedEncodingException, FileNotFoundException, IOException - { - final BufferedReader bufferReader = new BufferedReader(new InputStreamReader - (new FileInputStream(file), charset)); - - List contents = new ArrayList(); - String currentLine = null; - - try { - currentLine = bufferReader.readLine(); - while (currentLine != null) - { - contents.add(currentLine); - currentLine = bufferReader.readLine(); - } - } finally { - bufferReader.close(); - } - - return contents; - } - - /** - * Write lines to file. - *
- * This method is intended to be as fast as possible, so we are not checking - * the input parameters, it is under your responsability to pass the right - * values to this method. What basically means, you are not allowed to use null; - * an Object is always required for every input parameter. Otherwise you can expect a - * nice exception or something worse. - * - * @param contents the lines to be written in a {@link List} - * @param charset the file charset - * @param fileName the file name. Absolute or abstract pathname, it is your choice - * @throws FileNotFoundException if the file exists but is a directory rather - * than a regular file, does not exist but cannot be created, or cannot be - * opened for any other reason - * @throws UnsupportedEncodingException if the named encoding is not supported - * @throws SecurityException if a security manager exists and its - * checkWrite method denies write access. - */ - public final static void writeFile (final List contents, - final String fileName, final String charset) throws FileNotFoundException, UnsupportedEncodingException - { - final OutputStream outputStream = new FileOutputStream(fileName); - final PrintStream output = new PrintStream(outputStream, true, FormConfiguration.getCharset()); - - try { - for (String line : contents ) - { - output.println(line); - } - } - finally { - output.close(); - } - } - - /** - * Replace every line (file lines stored in a {@link List}) - * with the lineReplacement if the line contains the pattern - *
- * This method is intended to be as fast as possible, so we are not checking - * the input parameters, it is under your responsability to pass the right - * values to this method. What basically means, you are not allowed to use null; - * an Object is always required for every input parameter. Otherwise you can expect a - * nice exception or something worse. - * - * @param contents the lines to be searched in a {@link List} - * @param pattern the pattern to match in a line - * @param lineReplacement the whole line to replace in case of some match - * @return true if there is a match, otherwise false - * @throws NullPointerException if pattern is null - */ - public final static boolean replaceLine (final List contents, final String pattern, final String lineReplacement) - { - final ListIterator itr = contents.listIterator(); - boolean change = false; - - while (itr.hasNext()) - { - if (itr.next().trim().contains(pattern)) { - itr.set(lineReplacement); - change = true; - } - } - - return change; - } - - /** - * Method intended to be used by the Logical layer. Search the template files - * of the form printer, replace the lines in case of match and write on the hard disk the - * new files. - * - * @param pattern the pattern to match - * @param lineReplacement the whole line to replace in case of some match - * @throws FileNotFoundException while writing or reading a file - * @throws UnsupportedEncodingException while writing or reading a file - * if the named charset is not supported - * @throws IOException if an I/O error occurs while writing or trying to open a file - * @throws NullPointerException if pattern or lineReplacement is null - */ - public final static void searchandReplace (final String pattern, - final String lineReplacement) throws UnsupportedEncodingException, FileNotFoundException, IOException - { - if (pattern != null && lineReplacement != null) { - final List fileList = PrinterLogicalHelper.findFilebyExtension(TEMPLATE_FILE_EXTENSION); - for (File file : fileList) - { - final List contents = PrinterLogicalHelper.readFile(file, FormConfiguration.getCharset()); - if (PrinterLogicalHelper.replaceLine(contents, pattern, lineReplacement)) - { - PrinterLogicalHelper.writeFile(contents, file.getAbsolutePath(), FormConfiguration.getCharset()); - } - } - } - else { - throw new NullPointerException("Input parameters in searchandReplace: " + - "invalid null. Object is required. First parameter, pattern: " + - pattern + " Second parameter, lineReplacement: " + lineReplacement); - } - } - - /** - *

- * This method is smart enough to find out if there is a new form printer model - * and write the new configuration in the right files.
- * It will change the templates and the dtg configuration file if it is required - * (right now while switching from TM-T88V to TM-T88X and vice versa) - *

- *

It is intended to hide the ins and outs of the whole nasty process.

- * - * @param oldModel The previous form printer model - * @param newModel The new form printer model - * @throws FileNotFoundException - * @throws UnsupportedEncodingException - * @throws IOException - * If an I/O error occurs while writing or trying to open a file - */ - public final static void changedPrinter (final HardwareModel oldModel, - final HardwareModel newModel) throws UnsupportedEncodingException, FileNotFoundException, IOException - { - if(FormPrinterModel.EPSON_TM_88_V.getXmlDescriptor().equals(newModel.getXmlDescriptor())) - { - PrinterLogicalHelper.searchandReplace(PATTERN_TO_TM88V, LINE_REPLACEMENT_TO_TM88V); - PrinterLogicalHelper.removeFormPrinterProperty(PRINTER_PROPERTY); - } - else if (FormPrinterModel.EPSON_TM_88_V.getXmlDescriptor().equals(oldModel.getXmlDescriptor())) - { - PrinterLogicalHelper.searchandReplace(PATTERN_FROM_TM88V, LINE_REPLACEMENT_FROM_TM88V); - PrinterLogicalHelper.addFormPrinterProperty(PRINTER_PROPERTY, PRINTER_PROPERTY_VALUE); - } - } -} \ No newline at end of file -- 2.1.4