oracle.stellent.ridc.model

Interface DataBinder

All Known Implementing Classes:

DataBinderImpl

@Exported
public interface DataBinder

A DataBinder is the Data Model Object used for Content Server communication. It encapsulates a set of local properties, a collection of result sets and option list values.

Method Summary

Modifier and Type	Method and Description
void	addFile(String name, File file) Add a file for a given file name.
void	addFile(String name, TransferFile file) Add a file for a given file name
void	addOptionList(String name, List<String> values) Add an option list with a given name
void	addResultSet(String name, DataResultSet resultSet) Add a result set with a given name
boolean	containsFiles() Check if there are files
String	getFieldType(String name) Retrieve the field type for a given field name.
Collection<String>	getFieldTypeNames() Retrieve all field names
TransferFile	getFile(String name) Retrieve a file for a given file name
Collection<String>	getFileNames() Retrieve all file names
String	getLocal(String name) Shortcut for getLocalData().get(name)
DataObject	getLocalData() Retrieve the local data
List<String>	getOptionList(String name) Retrieve a specific option list by name
Collection<String>	getOptionListNames() Retrieve all option list names
DataResultSet	getResultSet(String name) Retrieve the result set by name
Collection<String>	getResultSetNames() Retrieve all result set names
Map<String,DataResultSet>	getResultSets() Retrieve a map representation of the result sets, indexed by result set name.
void	merge(DataBinder source) This will merge copies of all the data from the source binder into this binder, overwriting existing values and result sets, if they exist.
void	putLocal(String name, String value) Shortcut for getLocalData().put(name,value)
void	removeFieldType(String name) Remove the field type mapping for a given field name
void	removeFile(String name) Remove a file for a given file name
void	removeOptionList(String name) Remove an option list for a given name
void	removeResultSet(String name) Remove the result set for a given name
void	setFieldType(String name, String type) Set a field type for a given field name

Method Detail

getLocalData

DataObject getLocalData()

Retrieve the local data

Returns:

the binder local data

getFieldType

String getFieldType(String name)

Retrieve the field type for a given field name.

Parameters:

name - the field name

Returns:

the field type or null if no type is mapped to this property

setFieldType

void setFieldType(String name,
                  String type)

Set a field type for a given field name

Parameters:

name - the field name

type - the new type

getFieldTypeNames

Collection<String> getFieldTypeNames()

Retrieve all field names

Returns:

a collection of the field names that have field type mappings

removeFieldType

void removeFieldType(String name)

Remove the field type mapping for a given field name

Parameters:

name - the field name to remove from the mappings table

getFileNames

Collection<String> getFileNames()

Retrieve all file names

Returns:

a list of file names

getFile

TransferFile getFile(String name)

Retrieve a file for a given file name

Parameters:

name - the file name

Returns:

the file stream or null if not found

addFile

void addFile(String name,
             File file)
      throws IOException

Add a file for a given file name. Shortcut for calling:

     addFile (name, new TransferStream (file));
 

Parameters:

name - the file name

file - the file object

Throws:

IOException - if the file cannot be read

See Also:

addFile(String, TransferFile)

addFile

void addFile(String name,
             TransferFile file)

Add a file for a given file name

Parameters:

name - the file name

file - the file stream

removeFile

void removeFile(String name)

Remove a file for a given file name

Parameters:

name - the file name

containsFiles

boolean containsFiles()

Check if there are files

Returns:

true if their are any files attached to this data binder

getLocal

String getLocal(String name)

Shortcut for getLocalData().get(name)

Parameters:

name - the local property name

Returns:

the value or null if not found

putLocal

void putLocal(String name,
              String value)

Shortcut for getLocalData().put(name,value)

Parameters:

name - the local property name

value - the local property value

getResultSet

DataResultSet getResultSet(String name)

Retrieve the result set by name

Parameters:

name - the result set name

Returns:

the result set or null if not found

getResultSets

Map<String,DataResultSet> getResultSets()

Retrieve a map representation of the result sets, indexed by result set name. Note: this is an unmodifiable map; add or removing of result sets is done through the addResultSet(String, DataResultSet) and removeResultSet(String) methods.

Returns:

a non-null map of the available result sets, indexed by result set name

See Also:

addResultSet(String, DataResultSet), removeResultSet(String), getResultSetNames()

getResultSetNames

Collection<String> getResultSetNames()

Retrieve all result set names

Returns:

a collection of the available result set names

addResultSet

void addResultSet(String name,
                  DataResultSet resultSet)

Add a result set with a given name

Parameters:

name - the result set name

resultSet - the result set

removeResultSet

void removeResultSet(String name)

Remove the result set for a given name

Parameters:

name - the result set name to remove

getOptionList

List<String> getOptionList(String name)

Retrieve a specific option list by name

Parameters:

name - the list name

Returns:

the list values

getOptionListNames

Collection<String> getOptionListNames()

Retrieve all option list names

Returns:

the names of the available option lists

addOptionList

void addOptionList(String name,
                   List<String> values)

Add an option list with a given name

Parameters:

name - the option list name

values - the values

removeOptionList

void removeOptionList(String name)

Remove an option list for a given name

Parameters:

name - the option list name

merge

void merge(DataBinder source)

This will merge copies of all the data from the source binder into this binder, overwriting existing values and result sets, if they exist.

Parameters:

source - the source databinder