RuleReader

Instance Constructors

new RuleReader(actions: Actions, charset: Charset, ruleDir: Option[File] = None)

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val actions: Actions
final def asInstanceOf[T0]: T0

Definition Classes
Any
val charset: Charset
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
implicit val codec: Codec
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def exportExtractionSchemas(input: String, outname: String, minimal: Boolean = false): Unit

Autogenerate aggregated markdown documentation **file** for a grammar, aggregating by _Type_ (i.e., the Label from the internal Taxonomy).
Autogenerate aggregated markdown documentation **file** for a grammar, aggregating by _Type_ (i.e., the Label from the internal Taxonomy). This view of the grammar tells consumers what they can expect to see (or what they _could_ expect to see) in an Extraction/Mention of a given Type (or Label).
input
the String content of the grammar yaml file
outname
output markdown file
def exportRuleSchemas(input: String, outname: String): Unit

Autogenerate markdown **file** that shows the metadata for each rule in the grammar.
Autogenerate markdown **file** that shows the metadata for each rule in the grammar. This is useful for those who have a harder time sifting through the yaml files which may be quite nested. One md block per rule, sorted alphabetically.
input
odin grammar yaml string
outname
the path to the output md file
def extractionSchemaObjects(input: String): Seq[ExtractionSchema]

Autogenerate extractionSchema objects for a grammar, aggregating by _Type_ (i.e., the Label from the internal Taxonomy).
Autogenerate extractionSchema objects for a grammar, aggregating by _Type_ (i.e., the Label from the internal Taxonomy). This entrypoint is for people who want to edit what is produced prior to exporting.
input
the String content of the simple yaml file
def extractionSchemas(input: String, minimal: Boolean = false): String

Autogenerate aggregated markdown documentation string for a grammar, aggregating by _Type_ (i.e., the Label from the internal Taxonomy).
Autogenerate aggregated markdown documentation string for a grammar, aggregating by _Type_ (i.e., the Label from the internal Taxonomy). This view of the grammar tells consumers what they can expect to see (or what they _could_ expect to see) in an Extraction/Mention of a given Type (or Label).
input
the String content of the grammar yaml file
returns
markdown file contents
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getGraph(data: Map[String, Any], default: String = OdinConfig.DEFAULT_GRAPH): String
def getRules(input: String): Seq[Rule]
def getVars(data: Map[String, Any]): Map[String, String]

gets the master file as a Map and returns the declared variables, if any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def mkExtractors(rules: Seq[Rule]): Vector[Extractor]
def mkRule(data: Map[String, Any], expand: (String) ⇒ Seq[String], template: (Any) ⇒ String, config: OdinConfig): Rule
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def newCrossSentenceExtractor(name: String, labels: Seq[String], priority: Priority, keep: Boolean, action: Action, leftWindow: Int, rightWindow: Int, anchorPattern: TokenExtractor, neighborPattern: TokenExtractor, anchorRole: String, neighborRole: String): CrossSentenceExtractor

Attributes
protected
def newGraphExtractor(name: String, labels: Seq[String], priority: Priority, keep: Boolean, action: Action, pattern: GraphPattern, config: OdinConfig): GraphExtractor

Attributes
protected
def newTokenExtractor(name: String, labels: Seq[String], priority: Priority, keep: Boolean, action: Action, pattern: TokenPattern): TokenExtractor

Attributes
protected
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def read(input: String): Vector[Extractor]
def readFileOrResource(s: String): String

Tries to read the path as a file first.
Tries to read the path as a file first. If it fails, then it tries to read from the jar resources.
def readOrImportVars(data: Any): Map[String, String]

Reads the variables declared directly or imports them from a file
val ruleDir: Option[File]
def ruleSchemaObjects(input: String): Seq[RuleSchema]

Autogenerate objects that can represent themselves as markdown blocks that show the metadata for each rule in the grammar using a Master file.
Autogenerate objects that can represent themselves as markdown blocks that show the metadata for each rule in the grammar using a Master file. This entrypoint is for people who want to edit what is produced prior to exporting. One md block per rule, sorted alphabetically.
input
yaml rule string
returns
scala Map with markdown table contents
def ruleSchemas(input: String): String

Autogenerate markdown file string content that shows the metadata for each rule in the grammar.
Autogenerate markdown file string content that shows the metadata for each rule in the grammar. This is useful for those who have a harder time sifting through the yaml files which may be quite nested. One md block per rule, sorted alphabetically.
input
yaml rule string
returns
String contents of the rule documentation file
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object RuleReader | package impl

class RuleReader extends AnyRef

Instance Constructors

new RuleReader(actions: Actions, charset: Charset, ruleDir: Option[File] = None)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val actions: Actions

final def asInstanceOf[T0]: T0

val charset: Charset

def clone(): AnyRef

implicit val codec: Codec

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def exportExtractionSchemas(input: String, outname: String, minimal: Boolean = false): Unit

def exportRuleSchemas(input: String, outname: String): Unit

def extractionSchemaObjects(input: String): Seq[ExtractionSchema]

def extractionSchemas(input: String, minimal: Boolean = false): String

def finalize(): Unit

final def getClass(): Class[_]

def getGraph(data: Map[String, Any], default: String = OdinConfig.DEFAULT_GRAPH): String

def getRules(input: String): Seq[Rule]

def getVars(data: Map[String, Any]): Map[String, String]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def mkExtractors(rules: Seq[Rule]): Vector[Extractor]

def mkRule(data: Map[String, Any], expand: (String) ⇒ Seq[String], template: (Any) ⇒ String, config: OdinConfig): Rule

final def ne(arg0: AnyRef): Boolean

def newCrossSentenceExtractor(name: String, labels: Seq[String], priority: Priority, keep: Boolean, action: Action, leftWindow: Int, rightWindow: Int, anchorPattern: TokenExtractor, neighborPattern: TokenExtractor, anchorRole: String, neighborRole: String): CrossSentenceExtractor

def newGraphExtractor(name: String, labels: Seq[String], priority: Priority, keep: Boolean, action: Action, pattern: GraphPattern, config: OdinConfig): GraphExtractor

def newTokenExtractor(name: String, labels: Seq[String], priority: Priority, keep: Boolean, action: Action, pattern: TokenPattern): TokenExtractor

final def notify(): Unit

final def notifyAll(): Unit

def read(input: String): Vector[Extractor]

def readFileOrResource(s: String): String

def readOrImportVars(data: Any): Map[String, String]

val ruleDir: Option[File]

def ruleSchemaObjects(input: String): Seq[RuleSchema]

def ruleSchemas(input: String): String

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped