org.gvsig.scripting

Interface ScriptingUnit

All Known Subinterfaces:

ScriptingBaseScript, ScriptingDialog, ScriptingExternalFile, ScriptingFolder, ScriptingScript, ScriptingText, Unit

All Known Implementing Classes:

AbstractScript, AbstractUnit, DefaultScriptingDialog, DefaultScriptingExternalFile, DefaultScriptingExternalTextFile, DefaultScriptingFolder, DefaultScriptingScript, SystemFolder, UserFolder

public interface ScriptingUnit

Interface that represents the elements used in the ScriptingFramework.

See Also:

ScriptingBaseScript, ScriptingFolder

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener)
java.lang.String	getCreatedBy() Returns information about the ScriptingUnit's creator
java.lang.String	getDescription() Returns the ScriptingUnit's description
java.io.File	getFile() Gets a File with the ScriptUnit path name.
java.io.File	getFileResource(java.lang.String extension)
java.util.List<java.io.File>	getFiles() Return a list of the files that use this unit with out the inf file.
java.lang.String[]	getIconNames() Gets the name of the icons associated to the ScriptingUnit type.
java.lang.String	getId() Returns the ScriptingUnit's ID
java.lang.String	getName() Returns the ScriptingUnit's name
ScriptingFolder	getParent() Returns the ScriptingUnit's parent
java.util.Map<java.lang.String,java.lang.String>	getProperties()
java.lang.String	getProperty(java.lang.String name)
java.lang.String	getTypeName()
java.lang.String	getUserPath()
java.lang.String	getVersion() Returns the ScriptingUnit's version
boolean	isASystemUnit()
boolean	isSaved() Indicates if the ScriptBaseScript is modified from last saved version.
boolean	move(ScriptingFolder target) Moves a ScriptingUnitfrom the current directory to the new location.
void	reload()
boolean	remove()
boolean	rename(java.lang.String newId) Changes the ID of a ScriptingUnit and the name of the files and/or directories associated
void	setCreatedBy(java.lang.String createdBy) Sets a new information about the ScriptingUnit's creator.
void	setDescription(java.lang.String description) Sets a new description to the ScriptingUnit.
void	setName(java.lang.String name) Sets a new name to the ScriptingUnit.
void	setProperty(java.lang.String name, java.lang.String value)
void	setSaved(boolean saved) Sets the unit current status with the saved version.
void	setVersion(java.lang.String version) Sets a new version value to the ScriptingUnit.

Method Detail

getId

java.lang.String getId()

Returns the ScriptingUnit's ID

Returns:

a String containing the ScriptingUnit's ID

getName

java.lang.String getName()

Returns the ScriptingUnit's name

Returns:

a String containing the ScriptingUnit's name

getDescription

java.lang.String getDescription()

Returns the ScriptingUnit's description

Returns:

a String containing the ScriptingUnit's description

getCreatedBy

java.lang.String getCreatedBy()

Returns information about the ScriptingUnit's creator

Returns:

a String containing the ScriptingUnit's creator

getVersion

java.lang.String getVersion()

Returns the ScriptingUnit's version

Returns:

a String containing the ScriptingUnit's version

getParent

ScriptingFolder getParent()

Returns the ScriptingUnit's parent

Returns:

a ScriptingFolder where is contained the ScriptingUnit

getUserPath

java.lang.String getUserPath()

setName

void setName(java.lang.String name)

Sets a new name to the ScriptingUnit.

Parameters:

name - String that contains the new name.

setDescription

void setDescription(java.lang.String description)

Sets a new description to the ScriptingUnit.

Parameters:

description - String that contains the new description.

setCreatedBy

void setCreatedBy(java.lang.String createdBy)

Sets a new information about the ScriptingUnit's creator.

Parameters:

createdBy - String that contains the new creator's information.

setVersion

void setVersion(java.lang.String version)

Sets a new version value to the ScriptingUnit.

Parameters:

version - String that contains the new version.

reload

void reload()

rename

boolean rename(java.lang.String newId)

Changes the ID of a ScriptingUnit and the name of the files and/or directories associated

Parameters:

newId - String that contains the new Id.

Returns:

true if it's succesful, false if not.

remove

boolean remove()

move

boolean move(ScriptingFolder target)

Moves a ScriptingUnitfrom the current directory to the new location.

Parameters:

target - ScriptingFolder that represents the destination..

Returns:

true if it's succesful, false if not.

getIconNames

java.lang.String[] getIconNames()

Gets the name of the icons associated to the ScriptingUnit type.

Returns:

a String array with the identificators of the icons associated.

getTypeName

java.lang.String getTypeName()

getFile

java.io.File getFile()

Gets a File with the ScriptUnit path name.

Returns:

a string with the path name of the ScriptUnit (inf/folder).

getFiles

java.util.List<java.io.File> getFiles()

Return a list of the files that use this unit with out the inf file.

Returns:

list of files of the unit.

addPropertyChangeListener

void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

setSaved

void setSaved(boolean saved)

Sets the unit current status with the saved version.

Parameters:

saved - Indicate if the unit is up-to-date or not.

isSaved

boolean isSaved()

Indicates if the ScriptBaseScript is modified from last saved version.

Returns:

true if current version is up-to-date, false if not.

getProperty

java.lang.String getProperty(java.lang.String name)

setProperty

void setProperty(java.lang.String name,
                 java.lang.String value)

getProperties

java.util.Map<java.lang.String,java.lang.String> getProperties()

isASystemUnit

boolean isASystemUnit()

getFileResource

java.io.File getFileResource(java.lang.String extension)