Package | Description |
---|---|
cc.redpen |
contains
RedPen Main class and some important classes used thought
the project. |
cc.redpen.formatter |
Formatter and the implementations are provided.
|
cc.redpen.model |
Elements of Documents such as List, Sentence are provided.
|
cc.redpen.parser |
Parser and the implementations are provided.
|
cc.redpen.parser.markdown |
Markdown Parser are provided.
|
cc.redpen.validator |
Validators and the factory classes are provided.
|
cc.redpen.validator.section |
SectionValidators are provided.
|
Modifier and Type | Method and Description |
---|---|
Document |
RedPen.parse(DocumentParser parser,
InputStream InputStream)
parse given input stream.
|
Document |
RedPen.parse(DocumentParser parser,
String content)
parse given content.
|
Modifier and Type | Method and Description |
---|---|
List<Document> |
RedPen.parse(DocumentParser parser,
File[] files)
parse given files.
|
Map<Document,List<ValidationError>> |
RedPen.validate(List<Document> documents)
validate the input document collection.
|
Modifier and Type | Method and Description |
---|---|
List<ValidationError> |
RedPen.validate(Document document)
validate the input document collection.
|
Modifier and Type | Method and Description |
---|---|
Map<Document,List<ValidationError>> |
RedPen.validate(List<Document> documents)
validate the input document collection.
|
Modifier and Type | Method and Description |
---|---|
protected org.json.JSONObject |
JSONFormatter.asJSON(Document document,
List<ValidationError> errors)
Render as a JSON object a list of errors for a given document
|
protected org.json.JSONObject |
JSONBySentenceFormatter.asJSON(Document document,
List<ValidationError> errors)
Render as a JSON object a list of errors for a given document
|
String |
JSONFormatter.format(Document document,
List<ValidationError> errors) |
String |
Formatter.format(Document document,
List<ValidationError> errors)
Format the errors for a given document
|
String |
XMLFormatter.formatError(Document document,
ValidationError error) |
String |
PlainFormatter.formatError(Document document,
ValidationError error) |
String |
PlainBySentenceFormatter.formatError(Document document,
ValidationError error) |
String |
JSONFormatter.formatError(Document document,
ValidationError error) |
abstract String |
Formatter.formatError(Document document,
ValidationError error)
Format a single error as a string
|
Modifier and Type | Method and Description |
---|---|
String |
Formatter.format(Map<Document,List<ValidationError>> docErrorsMap)
Format errors for a set of documents as a String
|
void |
Formatter.format(OutputStream outputStream,
Map<Document,List<ValidationError>> docErrorsMap)
Format and print the errors for a set of documents
|
void |
XMLFormatter.format(PrintWriter pw,
Map<Document,List<ValidationError>> docErrorsMap) |
void |
PlainFormatter.format(PrintWriter pw,
Map<Document,List<ValidationError>> docErrorsMap) |
void |
PlainBySentenceFormatter.format(PrintWriter pw,
Map<Document,List<ValidationError>> docErrorsMap) |
void |
JSONFormatter.format(PrintWriter pw,
Map<Document,List<ValidationError>> docErrorsMap) |
abstract void |
Formatter.format(PrintWriter printWriter,
Map<Document,List<ValidationError>> docErrorsMap)
Format and print the errors for a set of documents
|
Modifier and Type | Method and Description |
---|---|
Document |
Document.DocumentBuilder.build() |
Modifier and Type | Method and Description |
---|---|
Document |
DocumentParser.parse(File file,
SentenceExtractor sentenceExtractor,
RedPenTokenizer tokenizer)
Given input file name, return Document instance for the specified file.
|
Document |
BaseDocumentParser.parse(File file,
SentenceExtractor sentenceExtractor,
RedPenTokenizer tokenizer) |
Document |
PlainTextParser.parse(InputStream is,
Optional<String> fileName,
SentenceExtractor sentenceExtractor,
RedPenTokenizer tokenizer) |
Document |
DocumentParser.parse(InputStream io,
Optional<String> fileName,
SentenceExtractor sentenceExtractor,
RedPenTokenizer tokenizer)
Given input stream, return Document instance from a stream.
|
Document |
AsciiDocParser.parse(InputStream io,
Optional<String> fileName,
SentenceExtractor sentenceExtractor,
RedPenTokenizer tokenizer) |
default Document |
DocumentParser.parse(InputStream is,
SentenceExtractor sentenceExtractor,
RedPenTokenizer tokenizer)
Given input stream, return Document instance from a stream.
|
Document |
DocumentParser.parse(String content,
SentenceExtractor sentenceExtractor,
RedPenTokenizer tokenizer)
Given content, return Document instance for the specified file.
|
Document |
BaseDocumentParser.parse(String content,
SentenceExtractor sentenceExtractor,
RedPenTokenizer tokenizer) |
Modifier and Type | Method and Description |
---|---|
Document |
ToFileContentSerializer.toFileContent(org.pegdown.ast.RootNode astRoot)
Traverse markdown tree that parsed Pegdown.
|
Modifier and Type | Method and Description |
---|---|
void |
Validator.validate(Document document)
validate the input document and returns the invalid points.
|
void |
JavaScriptValidator.validate(Document document) |
Modifier and Type | Method and Description |
---|---|
void |
WordFrequencyValidator.validate(Document document) |
void |
UnexpandedAcronymValidator.validate(Document document) |
void |
FrequentSentenceStartValidator.validate(Document document) |
Copyright © 2015. All rights reserved.