net.sf.hfst.TransducerHeader Class Reference

Public Member Functions
	TransducerHeader (FileInputStream file) throws java.io.IOException, FormatException
Boolean	begins_hfst3_header (ByteArray bytes)
void	read_hfst3_header (FileInputStream file) throws java.io.IOException, FormatException
int	getInputSymbolCount ()
int	getSymbolCount ()
int	getIndexTableSize ()
int	getTargetTableSize ()
Boolean	isWeighted ()
Boolean	hasHfst3Header ()
Boolean	isIntact ()

Detailed Description

On instantiation reads the transducer's header and provides an interface to it.

Constructor & Destructor Documentation

TransducerHeader()

net.sf.hfst.TransducerHeader.TransducerHeader

(

FileInputStream

file

)

throws java.io.IOException, FormatException

Read in the (56 bytes of) header information, which unfortunately is mostly in little-endian unsigned form.

Parameters

file	file stream pointing to a header

Member Function Documentation

begins_hfst3_header()

Boolean net.sf.hfst.TransducerHeader.begins_hfst3_header

(

ByteArray

bytes

)

whether bytes start with HFST 3 header

Parameters

bytes

bytes to check

Returns

true if HFST3 header, false otherwise

getIndexTableSize()

int net.sf.hfst.TransducerHeader.getIndexTableSize

(

)

Get index table size

Returns

index table size

getInputSymbolCount()

int net.sf.hfst.TransducerHeader.getInputSymbolCount

(

)

Get input symbol count

Returns

input symbol count

getSymbolCount()

int net.sf.hfst.TransducerHeader.getSymbolCount

(

)

Get symbol count

Returns

symbol count

getTargetTableSize()

int net.sf.hfst.TransducerHeader.getTargetTableSize

(

)

Get target table size

Returns

target table size

hasHfst3Header()

Boolean net.sf.hfst.TransducerHeader.hasHfst3Header

(

)

Whether it's hfst 3 header.

Returns

true if header, false otherwise

isIntact()

Boolean net.sf.hfst.TransducerHeader.isIntact

(

)

Whether it's intact.

Returns

true if intact, false otherwise

isWeighted()

Boolean net.sf.hfst.TransducerHeader.isWeighted

(

)

Whether it's weighted.

Returns

true if weighted, false otherwise

read_hfst3_header()

void net.sf.hfst.TransducerHeader.read_hfst3_header

(

FileInputStream

file

)

throws java.io.IOException, FormatException

read HFST 3 header.

Parameters

file	file that contains a header

---

The documentation for this class was generated from the following file:

• /home/flammie/github/flammie/omorfi/src/java/net/sf/hfst/TransducerHeader.java