org.gvsig.scripting

Interface ScriptingFolder

All Superinterfaces:

ScriptingUnit, Visitable

All Known Implementing Classes:

DefaultScriptingFolder, SystemFolder, UserFolder

public interface ScriptingFolder
extends ScriptingUnit, Visitable

Interface that represents a directory in the ScriptingFramework.

See Also:

ScriptingUnit

Method Summary

Modifier and Type	Method and Description
void	accept(Visitor visitor, java.util.function.Predicate<ScriptingUnit> includeFilter)
void	add(ScriptingUnit unit) Adds a ScriptingUnit to the ScriptingFolder.
java.lang.String	getProperty(java.lang.String group, java.lang.String name)
java.lang.String	getRawInf()
ScriptingUnit	getUnit(java.io.File file) Returns the ScriptingUnit associated with a File.
ScriptingUnit	getUnit(java.lang.String path)
java.util.List<ScriptingFolder>	getUnitFolders()
java.util.List<ScriptingUnit>	getUnits() Gets all the ScriptingUnits contained in a ScriptingFolder.
boolean	isLink()
void	remove(ScriptingUnit unit) Removes a ScriptingUnit from the ScriptingFolder.
void	save()
void	setIconNames(java.lang.String iconName, java.lang.String iconNameOpen)
void	setProperty(java.lang.String group, java.lang.String name, java.lang.String value)
void	setRawInf(java.lang.String rawInf)

Methods inherited from interface org.gvsig.scripting.ScriptingUnit

addPropertyChangeListener, getCreatedBy, getDescription, getFile, getFileResource, getFiles, getIconNames, getId, getName, getParent, getProperties, getProperty, getTypeName, getUserPath, getVersion, isASystemUnit, isSaved, move, reload, remove, rename, setCreatedBy, setDescription, setName, setProperty, setSaved, setVersion

Methods inherited from interface org.gvsig.tools.visitor.Visitable

accept, accept

Method Detail

add

void add(ScriptingUnit unit)

Adds a ScriptingUnit to the ScriptingFolder.

Parameters:

unit - ScriptingUnit to include.

remove

void remove(ScriptingUnit unit)

Removes a ScriptingUnit from the ScriptingFolder.

Parameters:

unit - ScriptingUnit to delete.

getUnit

ScriptingUnit getUnit(java.io.File file)

Returns the ScriptingUnit associated with a File.

Parameters:

file - File of the data origin.

Returns:

a ScriptingUnit with the content extracted from the file.

getUnit

ScriptingUnit getUnit(java.lang.String path)

getUnits

java.util.List<ScriptingUnit> getUnits()

Gets all the ScriptingUnits contained in a ScriptingFolder.

Returns:

a List with the ScriptingUnits.

getUnitFolders

java.util.List<ScriptingFolder> getUnitFolders()

isLink

boolean isLink()

accept

void accept(Visitor visitor,
            java.util.function.Predicate<ScriptingUnit> includeFilter)
     throws BaseException

Throws:

BaseException

save

void save()

getRawInf

java.lang.String getRawInf()

setRawInf

void setRawInf(java.lang.String rawInf)

getProperty

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

setProperty

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

setIconNames

void setIconNames(java.lang.String iconName,
                  java.lang.String iconNameOpen)