com.planet_ink.coffee_mud.Libraries.interfaces
Interface AbilityParameters.AbilityRecipeData

All Known Implementing Classes:
CMAbleParms.AbilityRecipeDataImpl
Enclosing interface:
AbilityParameters

public static interface AbilityParameters.AbilityRecipeData

An AbilityParameters interface for passing around a completely decoded CraftorAbility (Common Skill) recipe list, ready for manipulation by users. DEV NOTES: Data rows are a DVector (editor ID, data). However, it starts off as (List of possible editor IDs, data), until the correct ID is determined. For data rows, the offender is blankRow() below, which returns the confused set. The columns are always either a string, or a list of strings, for multi-use columns.


Method Summary
 DVector blankRow()
          Creates a new blank recipe row for alteration.
 java.lang.String[] columnHeaders()
          Returns the display name of each column, for display purposes.
 int[] columnLengths()
          Returns the display length of each column, for display purposes
 java.util.List<? extends java.lang.Object> columns()
          The columns of the recipe table, including multi-use and optional column data
 java.util.List<DVector> dataRows()
          The rows of data, representing the rows of recipes.
 int getClassFieldIndex()
          Returns the column number index that represents the Class of the objects created by this recipe.
 DVector newRow(java.lang.String classFieldData)
          Creates a new recipe row from the given Class information
 int numberOfDataColumns()
          Returns the number of columns that can contain recipe data
 java.lang.String parseError()
          Returns the last parse error when trying to parse a recipe file.
 java.lang.String recipeFilename()
          Returns the VFS filename of the recipe file
 java.lang.String recipeFormat()
          Returns the coded format of the recipe list, including optional data
 boolean wasVFS()
          Returns true if the recipe file, when loaded, was saved in the vfs
 

Method Detail

recipeFilename

java.lang.String recipeFilename()
Returns the VFS filename of the recipe file

Returns:
the VFS filename of the recipe file

recipeFormat

java.lang.String recipeFormat()
Returns the coded format of the recipe list, including optional data

Returns:
the coded format of the recipe list, including optional data

dataRows

java.util.List<DVector> dataRows()
The rows of data, representing the rows of recipes. One row per List item.

Returns:
rows of data, representing the rows of recipes. One row per List item.

columns

java.util.List<? extends java.lang.Object> columns()
The columns of the recipe table, including multi-use and optional column data

Returns:
columns of the recipe table, including multi-use and optional column data

columnLengths

int[] columnLengths()
Returns the display length of each column, for display purposes

Returns:
the display length of each column, for display purposes

columnHeaders

java.lang.String[] columnHeaders()
Returns the display name of each column, for display purposes.

Returns:
the display name of each column, for display purposes.

numberOfDataColumns

int numberOfDataColumns()
Returns the number of columns that can contain recipe data

Returns:
the number of columns that can contain recipe data

parseError

java.lang.String parseError()
Returns the last parse error when trying to parse a recipe file. null means no error.

Returns:
the last parse error when trying to parse a recipe file.

getClassFieldIndex

int getClassFieldIndex()
Returns the column number index that represents the Class of the objects created by this recipe.

Returns:
the column number index that represents the Class of the objects

newRow

DVector newRow(java.lang.String classFieldData)
Creates a new recipe row from the given Class information

Parameters:
classFieldData - the class info for the object in the recipe
Returns:
the new coded row.

blankRow

DVector blankRow()
Creates a new blank recipe row for alteration.

Returns:
a new blank recipe row for alteration.

wasVFS

boolean wasVFS()
Returns true if the recipe file, when loaded, was saved in the vfs

Returns:
true if the recipe is in the vfs, false for local fs