com.myscript.iink

Class RecognitionAssetsBuilder

java.lang.Object

com.myscript.iink.RecognitionAssetsBuilder

All Implemented Interfaces:

IAutoCloseable

public class RecognitionAssetsBuilder
extends java.lang.Object
implements IAutoCloseable

The RecognitionAssetsBuilder implements the tools to generate and save recognition assets.

Since:

1.2.4

Method Summary

Modifier and Type	Method and Description
protected void	checkNotClosed()
void	close() Deletes native counterpart of this auto closable object
void	compile(java.lang.String type, java.lang.String data) Compile data into a recognition asset.
java.lang.String	getCompilationErrors() Get the last compilation errors.
java.lang.String[]	getSupportedRecognitionAssetsTypes() Returns the set of recognition assets types that this recognition assets builder can handle.
boolean	isClosed() Tells whether the close() method has been called.
void	store(java.lang.String path) Save the previously compiled recognition asset.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

close

public final void close()

Description copied from interface: IAutoCloseable

Deletes native counterpart of this auto closable object

Specified by:

close in interface IAutoCloseable

isClosed

public final boolean isClosed()

Tells whether the close() method has been called. Once an object is closed any method will throw IllegalStateException.

Returns:

true if this object is closed.

checkNotClosed

protected final void checkNotClosed()

getSupportedRecognitionAssetsTypes

public final java.lang.String[] getSupportedRecognitionAssetsTypes()

Returns the set of recognition assets types that this recognition assets builder can handle.

Returns:

an unmodifiable set of the supported recognition assets type names.

compile

public void compile(java.lang.String type,
                    java.lang.String data)
             throws java.lang.IllegalArgumentException,
                    java.lang.RuntimeException

Compile data into a recognition asset.

Parameters:

type - the type of asset that will be generated.

data - the data to compile.

Throws:

java.lang.IllegalArgumentException - when type is not supported.

java.lang.RuntimeException - when the content of data could not be compiled into a recognition asset.

getCompilationErrors

public final java.lang.String getCompilationErrors()

Get the last compilation errors.

Returns:

a description of the errors that occurred during the last compilation.

store

public void store(java.lang.String path)
           throws java.io.IOException

Save the previously compiled recognition asset.

Parameters:

path - the path to destination file.

Throws:

java.io.IOException - when there is no valid recognition asset to store.

java.io.IOException - if an I/O operation fails.