Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TOREVIEW] Labo-java-IO #11

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open

[TOREVIEW] Labo-java-IO #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
79095d3
update of file UpperCaseFilterWriter
cedriclankeu Mar 20, 2019
8749d14
UpperCaseFilterWriter file updated v2
cedriclankeu Mar 20, 2019
43b547a
UpperCaseFilterWriter file updated , then the test in class Utils are ok
cedriclankeu Mar 20, 2019
a26b708
dfsExplore is working, test done
cedriclankeu Mar 21, 2019
9768656
FileTransformer and
cedriclankeu Mar 21, 2019
054d638
dfs updated with light changes
cedriclankeu Mar 23, 2019
aa13c0a
FileNumberingFilterWriter test is ok
cedriclankeu Mar 23, 2019
10c02f8
CompleteFileTransformer modified and it test is ok
cedriclankeu Mar 23, 2019
5ec1638
Utils was already done when doing UpperCaseFilterWriter but forgoted …
cedriclankeu Mar 23, 2019
7d95e0d
ApplicationTest is done
cedriclankeu Mar 23, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
284 changes: 155 additions & 129 deletions LabJavaIO/src/main/java/ch/heigvd/res/labio/impl/Application.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,147 +7,173 @@
import ch.heigvd.res.labio.interfaces.IFileVisitor;
import ch.heigvd.res.labio.quotes.QuoteClient;
import ch.heigvd.res.labio.quotes.Quote;
import java.io.File;
import java.io.IOException;
import java.io.StringWriter;
import java.io.Writer;

import java.io.*;
import java.util.logging.Level;
import java.util.logging.Logger;

import org.apache.commons.io.FileUtils;

/**
*
* @author Olivier Liechti
*/
public class Application implements IApplication {

/**
* This constant defines where the quotes will be stored. The path is relative
* to where the Java application is invoked.
*/
public static String WORKSPACE_DIRECTORY = "./workspace/quotes";

private static final Logger LOG = Logger.getLogger(Application.class.getName());

public static void main(String[] args) {

/*
* I prefer to have LOG output on a single line, it's easier to read. Being able
* to change the formatting of console outputs is one of the reasons why it is
* better to use a Logger rather than using System.out.println
/**
* This constant defines where the quotes will be stored. The path is relative
* to where the Java application is invoked.
*/
public static String WORKSPACE_DIRECTORY = "./workspace/quotes";

private static final Logger LOG = Logger.getLogger(Application.class.getName());

public static void main(String[] args) {

/*
* I prefer to have LOG output on a single line, it's easier to read. Being able
* to change the formatting of console outputs is one of the reasons why it is
* better to use a Logger rather than using System.out.println
*/
System.setProperty("java.util.logging.SimpleFormatter.format", "%4$s: %5$s%6$s%n");


int numberOfQuotes = 0;
try {
numberOfQuotes = Integer.parseInt(args[0]);
} catch (Exception e) {
System.err.println("The command accepts a single numeric argument (number of quotes to fetch)");
System.exit(-1);
}

Application app = new Application();
try {
/*
* Step 1 : clear the output directory
*/
app.clearOutputDirectory();

/*
* Step 2 : use the QuotesClient to fetch quotes; store each quote in a file
*/
app.fetchAndStoreQuotes(numberOfQuotes);

/*
* Step 3 : use a file explorer to traverse the file system; print the name of each directory and file
*/
Writer writer = new StringWriter(); // we create a special writer that will send characters into a string (memory)
app.printFileNames(writer); // we hand over this writer to the printFileNames method
LOG.info(writer.toString()); // we dump the whole result on the console

/*
* Step 4 : process the quote files, by applying 2 transformations to their content
* (convert to uppercase and add line numbers)
*/
app.processQuoteFiles();

} catch (IOException ex) {
LOG.log(Level.SEVERE, "Could not fetch quotes. {0}", ex.getMessage());
ex.printStackTrace();
}
}

@Override
public void fetchAndStoreQuotes(int numberOfQuotes) throws IOException {
clearOutputDirectory();
QuoteClient client = new QuoteClient();
for (int i = 0; i < numberOfQuotes; i++) {
Quote quote = client.fetchQuote();
/* There is a missing piece here!
* As you can see, this method handles the first part of the lab. It uses the web service
* client to fetch quotes. We have removed a single line from this method. It is a call to
* one method provided by this class, which is responsible for storing the content of the
* quote in a text file (and for generating the directories based on the tags).
*/
storeQuote(quote, "quote-" + (i) + ".utf8");

LOG.info("Received a new joke with " + quote.getTags().size() + " tags.");
for (String tag : quote.getTags()) {
LOG.info("> " + tag);
}
}
}

/**
* This method deletes the WORKSPACE_DIRECTORY and its content. It uses the
* apache commons-io library. You should call this method in the main method.
*
* @throws IOException
*/
void clearOutputDirectory() throws IOException {
FileUtils.deleteDirectory(new File(WORKSPACE_DIRECTORY));
}

/**
* This method stores the content of a quote in the local file system. It has
* 2 responsibilities:
* <p>
* - with quote.getTags(), it gets a list of tags and uses
* it to create sub-folders (for instance, if a quote has three tags "A", "B" and
* "C", it will be stored in /quotes/A/B/C/quotes-n.utf8.
* <p>
* - with quote.getQuote(), it has access to the text of the quote. It stores
* this text in UTF-8 file.
*
* @param quote the quote object, with tags and text
* @param filename the name of the file to create and where to store the quote text
* @throws IOException
*/
System.setProperty("java.util.logging.SimpleFormatter.format", "%4$s: %5$s%6$s%n");


int numberOfQuotes = 0;
try {
numberOfQuotes = Integer.parseInt(args[0]);
} catch (Exception e) {
System.err.println("The command accepts a single numeric argument (number of quotes to fetch)");
System.exit(-1);
void storeQuote(Quote quote, String filename) throws IOException {

String dirPath = WORKSPACE_DIRECTORY + File.separator;

// create sub-folders from list of tags and uses
for (String currentTag : quote.getTags()) {
dirPath += currentTag;
}

// Creates a new File instance from a parent abstract pathname and a child pathname string
dirPath += File.separator + filename;
File files = new File(dirPath);

// create a directory named with the abstract pathname of this abstract pathname’s parent
files.getParentFile().mkdirs();

FileWriter fw = new FileWriter(files);
fw.write(quote.getQuote());
fw.close();

}

Application app = new Application();
try {
/*
* Step 1 : clear the output directory
*/
app.clearOutputDirectory();

/*
* Step 2 : use the QuotesClient to fetch quotes; store each quote in a file
*/
app.fetchAndStoreQuotes(numberOfQuotes);

/*
* Step 3 : use a file explorer to traverse the file system; print the name of each directory and file
*/
Writer writer = new StringWriter(); // we create a special writer that will send characters into a string (memory)
app.printFileNames(writer); // we hand over this writer to the printFileNames method
LOG.info(writer.toString()); // we dump the whole result on the console

/*
* Step 4 : process the quote files, by applying 2 transformations to their content
* (convert to uppercase and add line numbers)
*/
app.processQuoteFiles();

} catch (IOException ex) {
LOG.log(Level.SEVERE, "Could not fetch quotes. {0}", ex.getMessage());
ex.printStackTrace();

/**
* This method uses a IFileExplorer to explore the file system and prints the name of each
* encountered file and directory.
*/
void printFileNames(final Writer writer) {

IFileExplorer explorer = new DFSFileExplorer();

explorer.explore(new File(WORKSPACE_DIRECTORY), new IFileVisitor() {
@Override
public void visit(File file) {
/*
* There is a missing piece here. Notice how we use an anonymous class here. We provide the implementation
* of the the IFileVisitor interface inline. You just have to add the body of the visit method, which should
* be pretty easy (we want to write the filename, including the path, to the writer passed in argument).
*/
try { // write file name and his path
writer.write(file.getPath() + '\n');
} catch (IOException ex) {
LOG.log(Level.SEVERE, "Error writing file name and path", ex.getMessage());
ex.printStackTrace();
}
}
});
}
}

@Override
public void fetchAndStoreQuotes(int numberOfQuotes) throws IOException {
clearOutputDirectory();
QuoteClient client = new QuoteClient();
for (int i = 0; i < numberOfQuotes; i++) {
Quote quote = client.fetchQuote();
/* There is a missing piece here!
* As you can see, this method handles the first part of the lab. It uses the web service
* client to fetch quotes. We have removed a single line from this method. It is a call to
* one method provided by this class, which is responsible for storing the content of the
* quote in a text file (and for generating the directories based on the tags).
*/
LOG.info("Received a new joke with " + quote.getTags().size() + " tags.");
for (String tag : quote.getTags()) {
LOG.info("> " + tag);
}

@Override
public void processQuoteFiles() throws IOException {
IFileExplorer explorer = new DFSFileExplorer();
explorer.explore(new File(WORKSPACE_DIRECTORY), new CompleteFileTransformer());
}
}

/**
* This method deletes the WORKSPACE_DIRECTORY and its content. It uses the
* apache commons-io library. You should call this method in the main method.
*
* @throws IOException
*/
void clearOutputDirectory() throws IOException {
FileUtils.deleteDirectory(new File(WORKSPACE_DIRECTORY));
}

/**
* This method stores the content of a quote in the local file system. It has
* 2 responsibilities:
*
* - with quote.getTags(), it gets a list of tags and uses
* it to create sub-folders (for instance, if a quote has three tags "A", "B" and
* "C", it will be stored in /quotes/A/B/C/quotes-n.utf8.
*
* - with quote.getQuote(), it has access to the text of the quote. It stores
* this text in UTF-8 file.
*
* @param quote the quote object, with tags and text
* @param filename the name of the file to create and where to store the quote text
* @throws IOException
*/
void storeQuote(Quote quote, String filename) throws IOException {
throw new UnsupportedOperationException("The student has not implemented this method yet.");
}

/**
* This method uses a IFileExplorer to explore the file system and prints the name of each
* encountered file and directory.
*/
void printFileNames(final Writer writer) {
IFileExplorer explorer = new DFSFileExplorer();
explorer.explore(new File(WORKSPACE_DIRECTORY), new IFileVisitor() {
@Override
public void visit(File file) {
/*
* There is a missing piece here. Notice how we use an anonymous class here. We provide the implementation
* of the the IFileVisitor interface inline. You just have to add the body of the visit method, which should
* be pretty easy (we want to write the filename, including the path, to the writer passed in argument).
*/
}
});
}

@Override
public void processQuoteFiles() throws IOException {
IFileExplorer explorer = new DFSFileExplorer();
explorer.explore(new File(WORKSPACE_DIRECTORY), new CompleteFileTransformer());
}

}
52 changes: 37 additions & 15 deletions LabJavaIO/src/main/java/ch/heigvd/res/labio/impl/Utils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,47 @@

import java.util.logging.Logger;

import static com.sun.javafx.util.Utils.split;

/**
*
* @author Olivier Liechti
*/
public class Utils {

private static final Logger LOG = Logger.getLogger(Utils.class.getName());

/**
* This method looks for the next new line separators (\r, \n, \r\n) to extract
* the next line in the string passed in arguments.
*
* @param lines a string that may contain 0, 1 or more lines
* @return an array with 2 elements; the first element is the next line with
* the line separator, the second element is the remaining text. If the argument does not
* contain any line separator, then the first element is an empty string.
*/
public static String[] getNextLine(String lines) {
throw new UnsupportedOperationException("The student has not implemented this method yet.");
}
private static final Logger LOG = Logger.getLogger(Utils.class.getName());

/**
* This method looks for the next new line separators (\r, \n, \r\n) to extract
* the next line in the string passed in arguments.
*
* @param lines a string that may contain 0, 1 or more lines
* @return an array with 2 elements; the first element is the next line with
* the line separator, the second element is the remaining text. If the argument does not
* contain any line separator, then the first element is an empty string.
*/
public static String[] getNextLine(String lines) {
//throw new UnsupportedOperationException("The student has not implemented this method yet.");

String[] nextLine;
if (lines.contains("\r\n")) {
// contain "\r\n" as line separator
nextLine = lines.split("\r\n", 2);
nextLine[0] += "\r\n";
} else if (lines.contains("\r")) {
// contain "\r" as line separator
nextLine = lines.split("\r", 2);
nextLine[0] += "\r";
} else if (lines.contains("\n")) {
// contain "\n" as line separator
nextLine = lines.split("\n", 2);
nextLine[0] += "\n";

} else
// do not contain any line separator, then the first element is an empty string
nextLine = new String[]{"", lines};

return nextLine;

}

}
Loading