arcade.mod.model
Interface IModel

All Known Implementing Classes:

XMLModel

public interface IModel

An interface specifying a model for use in the mod environment. The model is designed according to the Model-View-Presenter paradigm. Capable of producing a list of resource types and returning resources of the selected type as ResourceNodes. Also capable of writing the current ResouceNodes held in the model to a file.

Method Summary

java.util.Collection<java.lang.String>	getCategories() Get available categories or types of resources held by the model
java.util.List<IResourceNode>	getResourcesFromCategory(java.lang.String category) Returns all ResourceNodes of a given type specified by a String.
void	writeResources(java.io.File file) Write the resources to a file for use when running a game mod or to edit later.

Method Detail

getCategories

java.util.Collection<java.lang.String> getCategories()

Get available categories or types of resources held by the model

Returns:

The categories of resources in the model

getResourcesFromCategory

java.util.List<IResourceNode> getResourcesFromCategory(java.lang.String category)

Returns all ResourceNodes of a given type specified by a String. To get a Collection of valid Strings, call the getCategories() method first. These ResourceNodes will contain all of the information and behavior required to get and edit mod-able information in the Model.

Parameters:

category -

Returns:

writeResources

void writeResources(java.io.File file)

Write the resources to a file for use when running a game mod or to edit later. Format of the resources depends on model implementation.

Parameters:

file - File which the resources should be written to.