org.openksavi.sponge.core.kb

Class FileKnowledgeBaseScript

java.lang.Object

org.openksavi.sponge.core.kb.BaseKnowledgeBaseScript

org.openksavi.sponge.core.kb.FileKnowledgeBaseScript

All Implemented Interfaces:

KnowledgeBaseScript

public class FileKnowledgeBaseScript
extends BaseKnowledgeBaseScript

File-based knowledge base script definition.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_REQUIRED The script file is required by default.

Constructor Summary

Constructors

Constructor and Description
FileKnowledgeBaseScript(String fileName) Creates a new knowledge base script instance.
FileKnowledgeBaseScript(String fileName, boolean required) Creates a new knowledge base script instance.
FileKnowledgeBaseScript(String fileName, Charset charset) Creates a new knowledge base script instance.
FileKnowledgeBaseScript(String fileName, Charset charset, boolean required) Creates a new knowledge base script instance.

Method Summary

Modifier and Type	Method and Description
Charset	getCharset() Returns the charset.
String	getFileName()
boolean	isRequired() Returns true if the file is required.
void	setCharset(Charset charset) Sets the charset.
void	setRequired(boolean required) Sets if the file is required.

Methods inherited from class org.openksavi.sponge.core.kb.BaseKnowledgeBaseScript

getKnowledgeBase, getName, setKnowledgeBase, toString

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_REQUIRED

public static final boolean DEFAULT_REQUIRED

The script file is required by default.

See Also:

Constant Field Values

Constructor Detail

FileKnowledgeBaseScript

public FileKnowledgeBaseScript(String fileName)

Creates a new knowledge base script instance.

Parameters:

fileName - the knowledge base script file name.

FileKnowledgeBaseScript

public FileKnowledgeBaseScript(String fileName,
                               Charset charset)

Creates a new knowledge base script instance.

Parameters:

fileName - file name.

charset - charset.

FileKnowledgeBaseScript

public FileKnowledgeBaseScript(String fileName,
                               boolean required)

Creates a new knowledge base script instance.

Parameters:

fileName - file name.

required - required.

FileKnowledgeBaseScript

public FileKnowledgeBaseScript(String fileName,
                               Charset charset,
                               boolean required)

Creates a new knowledge base script instance.

Parameters:

fileName - file name.

charset - charset.

required - required.

Method Detail

getFileName

public String getFileName()

getCharset

public Charset getCharset()

Returns the charset.

Returns:

the charset.

setCharset

public void setCharset(Charset charset)

Sets the charset.

Parameters:

charset - the charset.

isRequired

public boolean isRequired()

Returns true if the file is required.

Returns:

true if the file is required.

setRequired

public void setRequired(boolean required)

Sets if the file is required.

Parameters:

required - true if the file is required.