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.parser |
Parser and the implementations are provided.
|
cc.redpen.parser.markdown |
Markdown Parser are provided.
|
cc.redpen.util |
Utility classes are provided.
|
cc.redpen.validator |
Validators and the factory classes are provided.
|
cc.redpen.validator.section |
SectionValidators are provided.
|
cc.redpen.validator.sentence |
SentenceValidators are provided.
|
Modifier and Type | Method and Description |
---|---|
Configuration |
ConfigurationLoader.load(File configFile)
load
RedPen settings. |
Configuration |
ConfigurationLoader.load(InputStream stream)
load
RedPen configuration. |
Configuration |
ConfigurationLoader.loadFromResource(String resourcePath)
load
RedPen settings. |
Configuration |
ConfigurationLoader.loadFromString(String configString)
load
RedPen settings. |
List<Document> |
RedPen.parse(DocumentParser parser,
File[] files)
parse given files.
|
Document |
RedPen.parse(DocumentParser parser,
InputStream InputStream)
parse given input stream.
|
Document |
RedPen.parse(DocumentParser parser,
String content)
parse given content.
|
Constructor and Description |
---|
RedPen(Configuration configuration)
constructs RedPen with specified configuration.
|
RedPen(File configFile)
constructs RedPen with specified config file.
|
RedPen(String configPath)
constructs RedPen with specified config file path.
|
Modifier and Type | Method and Description |
---|---|
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
|
String |
XMLFormatter.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 |
---|---|
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 |
---|---|
E |
DictionaryLoader.loadCachedFromFile(File file,
String dictionaryName)
returns word list loaded from file
|
E |
DictionaryLoader.loadCachedFromResource(String path,
String dictionaryName)
returns word list loaded from resource
|
Modifier and Type | Method and Description |
---|---|
static Validator |
ValidatorFactory.getInstance(String validatorName) |
static Validator |
ValidatorFactory.getInstance(ValidatorConfiguration config,
SymbolTable symbolTable) |
protected void |
Validator.init()
Validation initialization, called after the configuration and symbol tables have been assigned
|
protected void |
JavaScriptValidator.init() |
Modifier and Type | Method and Description |
---|---|
protected void |
WordFrequencyValidator.init() |
protected void |
UnexpandedAcronymValidator.init() |
protected void |
SectionLengthValidator.init() |
protected void |
ParagraphStartWithValidator.init() |
protected void |
ParagraphNumberValidator.init() |
protected void |
FrequentSentenceStartValidator.init() |
protected void |
DuplicatedSectionValidator.init() |
Modifier and Type | Method and Description |
---|---|
protected void |
WordNumberValidator.init() |
protected void |
WeakExpressionValidator.init() |
protected void |
SuggestExpressionValidator.init() |
protected void |
StartWithCapitalLetterValidator.init() |
protected void |
SpellingValidator.init() |
protected void |
SpaceBetweenAlphabeticalWordValidator.init() |
protected void |
SentenceLengthValidator.init() |
protected void |
QuotationValidator.init() |
protected void |
ParenthesizedSentenceValidator.init() |
protected void |
OkuriganaValidator.init() |
protected void |
NumberFormatValidator.init() |
protected void |
KatakanaSpellCheckValidator.init() |
protected void |
KatakanaEndHyphenValidator.init() |
protected void |
InvalidWordValidator.init() |
protected void |
InvalidExpressionValidator.init() |
protected void |
EndOfSentenceValidator.init() |
protected void |
DoubleNegativeValidator.init() |
protected void |
DoubledWordValidator.init() |
protected void |
DoubledJoshiValidator.init() |
protected void |
CommaNumberValidator.init() |
Copyright © 2015. All rights reserved.