This is an automated email from the ASF dual-hosted git repository. mseidel pushed a commit to branch AOO42X in repository https://gitbox.apache.org/repos/asf/openoffice.git
The following commit(s) were added to refs/heads/AOO42X by this push: new 7de2d4d Fixed typos, removed whitespace 7de2d4d is described below commit 7de2d4d7a8e7188633f10daf107e662a13b72eed Author: mseidel <msei...@apache.org> AuthorDate: Mon Jan 4 16:06:31 2021 +0100 Fixed typos, removed whitespace (cherry picked from commit b556d77e0a6c6a9db178b78826704c50983873c0) --- .../filter/detection/typeDetection/Helper.java | 179 +++++++++++---------- 1 file changed, 90 insertions(+), 89 deletions(-) diff --git a/main/filter/qa/complex/filter/detection/typeDetection/Helper.java b/main/filter/qa/complex/filter/detection/typeDetection/Helper.java index 18cf8bc..a75d5e2 100644 --- a/main/filter/qa/complex/filter/detection/typeDetection/Helper.java +++ b/main/filter/qa/complex/filter/detection/typeDetection/Helper.java @@ -1,5 +1,5 @@ /************************************************************** - * + * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information @@ -7,16 +7,16 @@ * to you 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. - * + * *************************************************************/ @@ -44,27 +44,27 @@ import util.utils; /** Helper class for "TypeDetection" * This class do file hanlding. */ -public class Helper { - +public class Helper { + /** The runner log writer * @member m_log for log purposes - * @member m_sTestDocPath directory for seraching files to load - * @member m_vFiles list of all files describet in "files.csv" - * @member m_hFileURLs contains the postition of a file name in the m_vFiles Vector - * @member m_hFileTypes contains the postition of a file type in the m_vFiles Vector + * @member m_sTestDocPath directory for searching files to load + * @member m_vFiles list of all files described in "files.csv" + * @member m_hFileURLs contains the position of a file name in the m_vFiles Vector + * @member m_hFileTypes contains the position of a file type in the m_vFiles Vector * @member m_param the test parameters */ - + LogWriter m_log = null; String m_sTestDocPath = null; - + Vector m_vFiles = null; - + Hashtable m_hFileURLs = new Hashtable(); - + Hashtable m_hFileTypes = new Hashtable(); - + TestParameters m_param = null; /** @@ -76,50 +76,50 @@ public class Helper { * * @param log the log writer */ - + public Helper(TestParameters param, LogWriter log) { m_param = param; m_log = log; - - + + // get all files from the given directory m_sTestDocPath = (String)param.get("TestDocumentPath"); // get all files from "files.csv" m_vFiles = getToDoList((String)m_param.get("csv.files")); - + createFilesList(); } - + /** Reads a comma separated file (CSV). Every line of the file is - * repesented by an <code>Vector</code> entry. Every data entry of a row is + * represented by an <code>Vector</code> entry. Every data entry of a row is * also stored in a <code>Vector</code>. So the returned value is a * <code>Vector[][]</code> where the first dimension represents a row - * and the second dimenesion inclueds the data values. + * and the second dimension includes the data values. * @param csvFileName the name of the csv file * @return Vector filled with Vector filled with data of a row */ public Vector getToDoList(String csvFileName){ - - try { - + + try { + Vector vAll = new Vector(); Vector vFields = new Vector(); - + // get content of file Vector content = getCSVFileContent(csvFileName); - + // remove superfluous content like "#" started lines content = removeSuperfluousContent(content); - + // replace all place holders in file content = replacePlaceHolder(content); - + // create Enumeration Enumeration contentEnum = content.elements(); - + // the first line contains field names of the columns // split line by ";" StringTokenizer fields = new StringTokenizer( @@ -129,23 +129,23 @@ public class Helper { vFields.add(fields.nextElement()); fieldCount++; } - + // fill vData with data of CSV-row while (contentEnum.hasMoreElements()){ Vector vData = new Vector(); StringTokenizer data = new StringTokenizer( contentEnum.nextElement().toString(),";", true); - + // example: data = "firstData;secondData;;forthData" - // => three tokens => missing one data because the imagine + // => three tokens => missing one data because the imagined // "thirdData" was not received by data.nextToken() - // Therefore here comes a special handling for empty datas + // Therefore here comes a special handling for empty data boolean nextIsData = false; int dataCount = 0; while (data.hasMoreTokens()) { Object myToken = data.nextToken(); - // if the "thirdData" will be received, myToken=";" but + // if the "thirdData" will be received, myToken=";" but // vData must add an empty String if (myToken.equals(";")){ if (nextIsData ) { @@ -163,16 +163,16 @@ public class Helper { for (int i=dataCount; i < fieldCount; i++) vData.add(""); vAll.add(vData); } - - + + return vAll; - + } catch(ClassCastException e) { e.printStackTrace(); } return null; } - + /** The csv files "files", "preselectedFilter", "preselectedType" and * "serviceName" are delivered beside this class. This function seeks for * the csv files and read them. @@ -180,7 +180,7 @@ public class Helper { * @return a Vector containing the content of the file. <null/> if the file * cannot be read */ - + public Vector getCSVFileContent(String csvFileName) { try { Vector content = new Vector(); @@ -189,13 +189,13 @@ public class Helper { if ( m_param.DebugIsActive ) { System.out.println("Looking for "+csvFileName); } - + URL url = getClassURL(csvFileName); - + if (url != null) { URLConnection connection = url.openConnection(); InputStream in = connection.getInputStream(); - + br = new BufferedReader(new InputStreamReader(in)); try { while( ( line = br.readLine() ) != null ) { @@ -208,25 +208,25 @@ public class Helper { br.close(); return content; } - + }catch (IOException e) { }catch(java.lang.NullPointerException e) { return null; } return null; } - + /** returns a XInputStream of given file - * @param filePath the path to the file which shoud be loaded + * @param filePath the path to the file which should be loaded * @return the XInputStream, <null/> if the * file cannot be read * @throws NotConnectedException was thrown if it was not possible to open <CODE>filePath</CODE> */ - public XInputStream getFileStream( String filePath ) + public XInputStream getFileStream( String filePath ) throws NotConnectedException { return new StreamSimulator(filePath, true, m_param); } - + /** replaces place holder in preselectedFilter. * Because of filter names depend on StarOffice version like * "StarOffice 6.0 Textdokument" or ""StarSuite 7 Textdokument" @@ -236,32 +236,32 @@ public class Helper { * @return changed file content */ private Vector replacePlaceHolder(Vector content){ - + Vector vReturn = new Vector(); - - Vector placeHolders = new Vector(); + + Vector placeHolders = new Vector(); Enumeration m_params = m_param.keys(); String placeHolder = (String)m_param.get("placeHolder"); - - // get all place holdes from typeDetection.csv + + // get all placeholders from typeDetection.csv while (m_params.hasMoreElements()){ String holderKey = (String) m_params.nextElement(); if (holderKey.startsWith(placeHolder)){ placeHolders.add(holderKey); } } - - // replace all occurrences of place holders in 'CSVData' + + // replace all occurrences of placeholders in 'CSVData' Enumeration cont = content.elements(); - + while( cont.hasMoreElements() ) { - + String line = (String) cont.nextElement(); String newLine = line; Enumeration holders = placeHolders.elements(); - + while( holders.hasMoreElements() ) { - + String holder = (String) holders.nextElement(); int startPos = line.indexOf(holder); @@ -269,11 +269,11 @@ public class Helper { try{ String holderValue = (String) m_param.get(holder); - newLine = newLine.substring(0,startPos) + holderValue + + newLine = newLine.substring(0,startPos) + holderValue + newLine.substring(startPos + holder.length()); - + } catch (java.lang.IndexOutOfBoundsException e){ - m_log.println("ERROR: problems while creating placeholder" + + m_log.println("ERROR: problems while creating placeholder" + " replaced list: "+ e); } } @@ -282,10 +282,10 @@ public class Helper { } return vReturn; } - + /** Removes lines of an ascii file content which starts with "#" * or are empty - * @param content content of a csv fi�e + * @param content content of a csv file * @return a stripped Vector */ public Vector removeSuperfluousContent(Vector content){ @@ -303,11 +303,11 @@ public class Helper { return null; } } - - /** returns a <code>MediaDescripto</code> filled with given properties and + + /** returns a <code>MediaDescriptor</code> filled with given properties and * values. - * @param propNames String Array of propertie names - * @param values Objecr Array of propertie values + * @param propNames String Array of property names + * @param values Object Array of property values * @return <code>PropertyValue[]<code> * @see com.sun.star.beans.PropertyValue * @see com.sun.star.document.MediaDescriptor @@ -325,7 +325,7 @@ public class Helper { return props ; } - + /** Appends system file separator if needed * @param s the system path * @return system path with ending system file separator @@ -336,8 +336,8 @@ public class Helper { }else if(s == null) s = ""; return s; - } - + } + /** Returns the file URL for the given file name assembled by * "TestDocumentPath" of typeDetection.props and "fileURL" of files.csv * @param fileAlias the alias name of the file @@ -346,7 +346,7 @@ public class Helper { */ public String getURLforfileAlias(String fileAlias) throws FileAliasNotFoundException{ - try{ + try{ String fileURL = (String) m_hFileURLs.get(fileAlias).toString(); return utils.getFullURL(ensureEndingFileSep(m_sTestDocPath) + fileURL); } catch (java.lang.NullPointerException e){ @@ -358,7 +358,7 @@ public class Helper { /** Returns the file type for the given file name containing in files.csv * @param fileAlias the alias name of the file * @return file type - * @throws FileAliasNotFoundException was thrown if not alias was thorwn + * @throws FileAliasNotFoundException was thrown if not alias was thrown */ public String getTypeforfileAlias(String fileAlias) throws FileAliasNotFoundException{ @@ -370,22 +370,22 @@ public class Helper { } /** - * Filles the Hashtable m_hFileURLs with all file names and their URL + * Fills the Hashtable m_hFileURLs with all file names and their URL * and the Hashtable m_hFilesTypes with all file names and their file - * typ name. This informations are extracted from "files.csv" - * This is for faster acccess to get fileURL and fileType of fileAlias + * type name. This informations are extracted from "files.csv" + * This is for faster access to get fileURL and fileType of fileAlias */ public void createFilesList(){ for (int i = 0; i < m_vFiles.size();i++){ Vector toDo = (Vector) m_vFiles.get(i); - m_hFileURLs.put((String) toDo.get(0).toString(), + m_hFileURLs.put((String) toDo.get(0).toString(), (String) toDo.get(1).toString()); - m_hFileTypes.put((String) toDo.get(0).toString(), + m_hFileTypes.put((String) toDo.get(0).toString(), (String) toDo.get(2).toString()); } } - - + + /** Validate the returned file type for the file alias with the * possible file types * @param currentFileType the returned file type @@ -393,34 +393,34 @@ public class Helper { * @return true if valid */ public boolean checkFileType(String currentFileType, String fileTypes){ - + StringTokenizer data = new StringTokenizer(fileTypes,":", true); boolean found = false; while (data.hasMoreElements()) { - + String actualFileType = data.nextElement().toString(); - + found = found || currentFileType.equals(actualFileType); } return found; } - + /** creates an input/output parameter of <code>PropertyValue[]<code>. * @return PropertyValue[][] * @param PropVal a PropertyValue */ - public PropertyValue[][] createInOutPropertyValue(PropertyValue[] PropVal){ + public PropertyValue[][] createInOutPropertyValue(PropertyValue[] PropVal){ PropertyValue[][] dummy = new PropertyValue[1][]; dummy[0] = PropVal; return dummy; } - + public URL getClassURL(String fileName){ String PackagePath = this.getClass().getPackage().getName().replace('.','/'); return this.getClass().getResource("/" + PackagePath +"/" + fileName); } - + public String getClassURLString(String fileName){ return getClassURL(fileName).toString().replaceAll("file:",""); } @@ -428,12 +428,13 @@ public class Helper { } -/** This exeception should be thrown if a method seeks for an invalid alias name */ +/** This exception should be thrown if a method seeks for an invalid alias name */ class FileAliasNotFoundException extends java.lang.Exception{ /** throws error message with wrong alias name * @param fileAlias the alias name - */ + */ public FileAliasNotFoundException(String fileAlias){ super("Could not get '"+fileAlias +"'"); } } +