Package ca.phon.script

Class BasicScript

java.lang.Object

ca.phon.script.BasicScript

All Implemented Interfaces:

IExtendable, PhonScript, Appendable, CharSequence, Cloneable

Direct Known Subclasses:

LazyQueryScript

public class BasicScript
extends Object
implements PhonScript, Cloneable

Basic phon script in memory. This script stores the script text in an internal StringBuffer. This object is intended to be immutable, however sub-classes may alter the internal script using the provided buffer.

Constructor Summary

Constructors

Constructor	Description
BasicScript(File file)
BasicScript(String text)

Method Summary

Modifier and Type	Method	Description
boolean	addClassImport(String classImport)
boolean	addPackageImport(String pkgImport)
boolean	addRequirePath(URI uri)
BasicScript	append(boolean arg0)
BasicScript	append(char c)
BasicScript	append(char[] str)
BasicScript	append(char[] str, int offset, int len)
BasicScript	append(double d)
BasicScript	append(float f)
BasicScript	append(int i)
BasicScript	append(long lng)
BasicScript	append(CharSequence s)
BasicScript	append(CharSequence s, int start, int end)
BasicScript	append(Object obj)
BasicScript	append(String str)
BasicScript	append(StringBuffer sb)
BasicScript	appendCodePoint(int codePoint)
int	capacity()
char	charAt(int index)
Object	clone()
int	codePointAt(int index)
int	codePointBefore(int index)
int	codePointCount(int beginIndex, int endIndex)
BasicScript	delete(int start, int end)
BasicScript	deleteCharAt(int index)
void	ensureCapacity(int minimumCapacity)
protected StringBuffer	getBuffer()	Used by sub-classes to allow direct access to buffer
void	getChars(int srcBegin, int srcEnd, char[] dst, int dstBegin)
List<String>	getClassImports()	Get a list of classes that should be imported when the scope is created.
PhonScriptContext	getContext()	Get a script context for this script.
<T> T	getExtension(Class<T> cap)	Get the requested extension if available.
Set<Class<?>>	getExtensions()	Return all extension types supported
List<String>	getPackageImports()	Get required packages that should be imported when the scope is created.
List<URI>	getRequirePaths()	Get the list of URLs that should be available for script loading using the require function.
String	getScript()	Get the script text.
int	indexOf(String str)
int	indexOf(String str, int fromIndex)
BasicScript	insert(int offset, boolean b)
BasicScript	insert(int offset, char c)
BasicScript	insert(int offset, char[] str)
BasicScript	insert(int index, char[] str, int offset, int len)
BasicScript	insert(int offset, double d)
BasicScript	insert(int offset, float f)
BasicScript	insert(int offset, int i)
BasicScript	insert(int offset, long l)
BasicScript	insert(int dstOffset, CharSequence s)
BasicScript	insert(int dstOffset, CharSequence s, int start, int end)
BasicScript	insert(int offset, Object obj)
BasicScript	insert(int offset, String str)
int	lastIndexOf(String str)
int	lastIndexOf(String str, int fromIndex)
int	length()
int	offsetByCodePoints(int index, int codePointOffset)
<T> T	putExtension(Class<T> cap, T impl)	Add a new extension.
boolean	removeClassImport(String classImport)
<T> T	removeExtension(Class<T> cap)	Remove a capability.
boolean	removePackageImport(String pkgImport)
boolean	removeRequirePath(URI uri)
BasicScript	replace(int start, int end, String str)
PhonScriptContext	resetContext()	Resets query context.
BasicScript	reverse()
void	setCharAt(int index, char ch)
void	setLength(int newLength)
CharSequence	subSequence(int start, int end)
String	substring(int start)
String	substring(int start, int end)
void	trimToSize()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.CharSequence

chars, codePoints, isEmpty, toString

Constructor Details

BasicScript

public BasicScript(String text)

BasicScript

public BasicScript(File file)
            throws IOException

Throws:

IOException

Method Details

getBuffer

protected StringBuffer getBuffer()

Used by sub-classes to allow direct access to buffer

Returns:

script buffer

getScript

public String getScript()

Description copied from interface: PhonScript

Get the script text.

Specified by:

getScript in interface PhonScript

Returns:

script

getContext

public PhonScriptContext getContext()

Description copied from interface: PhonScript

Get a script context for this script. The context is used to compile and evaulate the script.

Specified by:

getContext in interface PhonScript

Returns:

the script context

resetContext

public PhonScriptContext resetContext()

Resets query context.

Specified by:

resetContext in interface PhonScript

Returns:

the current context (before reset)

getExtensions

public Set<Class<?>> getExtensions()

Description copied from interface: IExtendable

Return all extension types supported

Specified by:

getExtensions in interface IExtendable

getExtension

public <T> T getExtension(Class<T> cap)

Description copied from interface: IExtendable

Get the requested extension if available.

Specified by:

getExtension in interface IExtendable

Returns:

the capability object or null if the cability is not available

putExtension

public <T> T putExtension(Class<T> cap,
 T impl)

Description copied from interface: IExtendable

Add a new extension.

Specified by:

putExtension in interface IExtendable

Parameters:

cap - the extension to add

Returns:

the added extension implementation

removeExtension

public <T> T removeExtension(Class<T> cap)

Description copied from interface: IExtendable

Remove a capability.

Specified by:

removeExtension in interface IExtendable

Parameters:

cap - the capability to remove

getPackageImports

public List<String> getPackageImports()

Description copied from interface: PhonScript

Get required packages that should be imported when the scope is created. These packages will also be available to any script imported using the require() function.

Specified by:

getPackageImports in interface PhonScript

Returns:

the list of packages that should be available to this script and any dependencies

addPackageImport

public boolean addPackageImport(String pkgImport)

Specified by:

addPackageImport in interface PhonScript

removePackageImport

public boolean removePackageImport(String pkgImport)

Specified by:

removePackageImport in interface PhonScript

getClassImports

public List<String> getClassImports()

Description copied from interface: PhonScript

Get a list of classes that should be imported when the scope is created. These classes will also be availble to any script imported using the require() function.

Specified by:

getClassImports in interface PhonScript

Returns:

the list of classes that should be availble to this script and any dependencies

addClassImport

public boolean addClassImport(String classImport)

Specified by:

addClassImport in interface PhonScript

removeClassImport

public boolean removeClassImport(String classImport)

Specified by:

removeClassImport in interface PhonScript

getRequirePaths

public List<URI> getRequirePaths()

Description copied from interface: PhonScript

Get the list of URLs that should be available for script loading using the require function.

Specified by:

getRequirePaths in interface PhonScript

Returns:

list of javascript library folders

addRequirePath

public boolean addRequirePath(URI uri)

Specified by:

addRequirePath in interface PhonScript

removeRequirePath

public boolean removeRequirePath(URI uri)

Specified by:

removeRequirePath in interface PhonScript

clone

public Object clone()

Overrides:

clone in class Object

append

public BasicScript append(boolean arg0)

Specified by:

append in interface PhonScript

append

public BasicScript append(char c)

Specified by:

append in interface Appendable

Specified by:

append in interface PhonScript

append

public BasicScript append(char[] str,
 int offset,
 int len)

Specified by:

append in interface PhonScript

append

public BasicScript append(char[] str)

Specified by:

append in interface PhonScript

append

public BasicScript append(CharSequence s,
 int start,
 int end)

Specified by:

append in interface Appendable

Specified by:

append in interface PhonScript

append

public BasicScript append(CharSequence s)

Specified by:

append in interface Appendable

Specified by:

append in interface PhonScript

append

public BasicScript append(double d)

Specified by:

append in interface PhonScript

append

public BasicScript append(float f)

Specified by:

append in interface PhonScript

append

public BasicScript append(int i)

Specified by:

append in interface PhonScript

append

public BasicScript append(long lng)

Specified by:

append in interface PhonScript

append

public BasicScript append(Object obj)

Specified by:

append in interface PhonScript

append

public BasicScript append(String str)

Specified by:

append in interface PhonScript

append

public BasicScript append(StringBuffer sb)

Specified by:

append in interface PhonScript

appendCodePoint

public BasicScript appendCodePoint(int codePoint)

Specified by:

appendCodePoint in interface PhonScript

capacity

public int capacity()

Specified by:

capacity in interface PhonScript

charAt

public char charAt(int index)

Specified by:

charAt in interface CharSequence

Specified by:

charAt in interface PhonScript

codePointAt

public int codePointAt(int index)

Specified by:

codePointAt in interface PhonScript

codePointBefore

public int codePointBefore(int index)

Specified by:

codePointBefore in interface PhonScript

codePointCount

public int codePointCount(int beginIndex,
 int endIndex)

Specified by:

codePointCount in interface PhonScript

delete

public BasicScript delete(int start,
 int end)

Specified by:

delete in interface PhonScript

deleteCharAt

public BasicScript deleteCharAt(int index)

Specified by:

deleteCharAt in interface PhonScript

ensureCapacity

public void ensureCapacity(int minimumCapacity)

Specified by:

ensureCapacity in interface PhonScript

getChars

public void getChars(int srcBegin,
 int srcEnd,
 char[] dst,
 int dstBegin)

Specified by:

getChars in interface PhonScript

indexOf

public int indexOf(String str,
 int fromIndex)

Specified by:

indexOf in interface PhonScript

indexOf

public int indexOf(String str)

Specified by:

indexOf in interface PhonScript

insert

public BasicScript insert(int offset,
 boolean b)

Specified by:

insert in interface PhonScript

insert

public BasicScript insert(int offset,
 char c)

Specified by:

insert in interface PhonScript

insert

public BasicScript insert(int index,
 char[] str,
 int offset,
 int len)

Specified by:

insert in interface PhonScript

insert

public BasicScript insert(int offset,
 char[] str)

Specified by:

insert in interface PhonScript

insert

public BasicScript insert(int dstOffset,
 CharSequence s,
 int start,
 int end)

Specified by:

insert in interface PhonScript

insert

public BasicScript insert(int dstOffset,
 CharSequence s)

Specified by:

insert in interface PhonScript

insert

public BasicScript insert(int offset,
 double d)

Specified by:

insert in interface PhonScript

insert

public BasicScript insert(int offset,
 float f)

Specified by:

insert in interface PhonScript

insert

public BasicScript insert(int offset,
 int i)

Specified by:

insert in interface PhonScript

insert

public BasicScript insert(int offset,
 long l)

Specified by:

insert in interface PhonScript

insert

public BasicScript insert(int offset,
 Object obj)

Specified by:

insert in interface PhonScript

insert

public BasicScript insert(int offset,
 String str)

Specified by:

insert in interface PhonScript

lastIndexOf

public int lastIndexOf(String str,
 int fromIndex)

Specified by:

lastIndexOf in interface PhonScript

lastIndexOf

public int lastIndexOf(String str)

Specified by:

lastIndexOf in interface PhonScript

length

public int length()

Specified by:

length in interface CharSequence

Specified by:

length in interface PhonScript

offsetByCodePoints

public int offsetByCodePoints(int index,
 int codePointOffset)

Specified by:

offsetByCodePoints in interface PhonScript

replace

public BasicScript replace(int start,
 int end,
 String str)

Specified by:

replace in interface PhonScript

reverse

public BasicScript reverse()

Specified by:

reverse in interface PhonScript

setCharAt

public void setCharAt(int index,
 char ch)

Specified by:

setCharAt in interface PhonScript

setLength

public void setLength(int newLength)

Specified by:

setLength in interface PhonScript

subSequence

public CharSequence subSequence(int start,
 int end)

Specified by:

subSequence in interface CharSequence

Specified by:

subSequence in interface PhonScript

substring

public String substring(int start,
 int end)

Specified by:

substring in interface PhonScript

substring

public String substring(int start)

Specified by:

substring in interface PhonScript

trimToSize

public void trimToSize()

Specified by:

trimToSize in interface PhonScript