prerna.cache.ICache Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of semoss Show documentation
SEMOSS
The newest version!
package prerna.cache;

import java.io.BufferedReader;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.FileReader;
import java.io.IOException;
import java.io.Reader;
import java.io.UnsupportedEncodingException;
import java.nio.charset.Charset;

import org.apache.commons.io.FileUtils;
import org.apache.commons.io.IOUtils;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;

import prerna.util.Constants;

public interface ICache {
	
	static final Logger classLogger = LogManager.getLogger(ICache.class);

	String FILE_SEPARATOR = java.nio.file.FileSystems.getDefault().getSeparator();;
	
	/**
	 * Removes invalid characters in a folder/file name and replaces with an underscore
	 * @param s				The input folder/file name
	 * @return				A clean version of the input folder/file name
	 */
	static String cleanFolderAndFileName(String s){
		return s.replaceAll("[^a-zA-Z0-9-_\\.]", "_");
	}
	
	/**
	 * Writes an object to the specified file path
	 * The object is converted into a JSON object and then written to the file as a string
	 * @param filePath		The file location		
	 * @param vec			The objec tot write to the file
	 */
	static void writeToFile(String filePath, Object vec) {
		FileOutputStream os = null;
		try {
			// convert the POJO into a JSON string
			Gson gson = new GsonBuilder().disableHtmlEscaping().serializeSpecialFloatingPointValues().setPrettyPrinting().create();
			String data = gson.toJson(vec);
			os = new FileOutputStream(new File(filePath));
			// write the JSON string into the file
			IOUtils.write(data, os, Charset.forName("UTF-8"));
		} catch (UnsupportedEncodingException e) {
			classLogger.error(Constants.STACKTRACE, e);
		} catch (FileNotFoundException e) {
			classLogger.error(Constants.STACKTRACE, e);
		} catch (IOException e) {
			classLogger.error(Constants.STACKTRACE, e);
		} finally {
			// close the streams
			try {
				if(os != null) {
					os.close();
				}
			} catch (IOException e) {
				classLogger.error(Constants.STACKTRACE, e);
			}
		}
	}
	
	/**
	 * Ingest a file as a string
	 * @param filePath		The file path to ingest
	 * @return				The string containing the contents of the file
	 */
	static String readFromFileString(String filePath) {
    	Reader is = null;
    	FileReader fr = null;
        try {
        	File file = new File(filePath);
        	if(file.exists() && file.isFile()) {
	        	fr = new FileReader(new File(filePath));
	            is = new BufferedReader(fr);
	            // ingest all the file contents into a string
	            String retData = IOUtils.toString(is);
	            return retData;
        	}
        } catch (FileNotFoundException e) {
        	classLogger.error(Constants.STACKTRACE, e);
        } catch (IOException e) {
        	classLogger.error(Constants.STACKTRACE, e);
        } finally {
        	// close the readers
        	try {
	        	if(fr != null) {
	        		fr.close();
	        	}
	        	if(is != null) {
					is.close();
	        	}
        	} catch (IOException e) {
        		classLogger.error(Constants.STACKTRACE, e);
			}
        }

        return null;
	}
	
	/**
	 * Deletes a folder and all its sub-directories
	 * @param folderLocation	The location of the folder
	 */
	static void deleteFolder(String folderLocation) {
		File folder = new File(folderLocation);
		deleteFolder(folder);
	}
	
	/**
	 * Deletes a folder and all its sub-directories
	 * @param folderLocation	The location of the folder
	 */
	static void deleteFolder(File folder) {
		if(folder.exists() && folder.isDirectory()) {
			try {
				FileUtils.forceDelete(folder);
			} catch (IOException e) {
				classLogger.error(Constants.STACKTRACE, e);
			}
		}
	}
	
	/**
	 * Deletes a file
	 * @param file				The File object to delete
	 */
	static void deleteFile(File file) {
		if(file.exists() && file.isFile()) {
			try {
				FileUtils.forceDelete(file);
			} catch (IOException e) {
				classLogger.error(Constants.STACKTRACE, e);
			}
		}
	}
	
	/**
	 * Deletes a file
	 * @param fileLocation		The path to the file 
	 */
	static void deleteFile(String fileLocation) {
		File file = new File(fileLocation);
		deleteFile(file);
	}
	
}