de.jstacs.fx.repository

Class ResultRepository

java.lang.Object

de.jstacs.fx.repository.ResultRepository

public class ResultRepository
extends Object

Singleton repository of all Result that have been created in an Application run.

Author:

Jan Grau

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ResultRepository.ResultConsumer Interface for classes that consume Results, i.e., that need to react to the addition or removal of results from the repository.

Field Summary

Fields

Modifier and Type	Field and Description
static BooleanProperty	autosave Global property for an Application run, if the workspace is automatically saved to disk.

Method Summary

Modifier and Type	Method and Description
void	add(Result result) Adds a result to the repository
void	add(Result result, boolean store) Adds a result to the repository.
boolean	autostore() If autosave is set to true, the contents of the repository are stored to disk in a separate Thread.
List<Result>	filterByMimeAndExtendedType(String mime, String extendedType) Returns all Results in the repository that match the filter criteria.
List<Result>	getAllResults() Returns all results (top-level and nested in ResultSetResults) in the repository.
ArrayList<ResultRepository.ResultConsumer>	getConsumers() Returns the list of ResultRepository.ResultConsumers registered for the current ResultRepository.
static ResultRepository	getInstance() Returns the singleton instance of the ResultRepository.
List<Result>	getResults() Returns only the top-level Results of this repository.
void	notifyRefresh(Result renamed) Notifies this ResultRepository that a Result has been modified and consumers should be notified.
void	register(ResultRepository.ResultConsumer resultConsumer) Registers a ResultRepository.ResultConsumer to this repository.
boolean	remove(Result result) Removes a top-level result (i.e., no Result that are contained in ResultSetResults) from the repository.
void	restoreResultsFromXML(StringBuffer sb) Restores the contents of a repository from its XML representation.
StringBuffer	storeResultsToXML() Stores the current contents of the repository to an XML representation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

autosave

public static BooleanProperty autosave

Global property for an Application run, if the workspace is automatically saved to disk.

Method Detail

getInstance

public static ResultRepository getInstance()

Returns the singleton instance of the ResultRepository.

Returns:

the repository

notifyRefresh

public void notifyRefresh(Result renamed)

Notifies this ResultRepository that a Result has been modified and consumers should be notified.

Parameters:

renamed - the Result renamed

See Also:

ResultRepository.ResultConsumer

add

public void add(Result result)

Adds a result to the repository

Parameters:

result - the Result added

add

public void add(Result result,
                boolean store)

Adds a result to the repository. The repository is only autosaved if store is true. As many successive autostores could be inefficient for sequential addition of many objects, store should be true only for the last of a successive series of additions.

Parameters:

result - the Result added

store - if autosave should be considered.

autostore

public boolean autostore()

If autosave is set to true, the contents of the repository are stored to disk in a separate Thread.

Returns:

the state of autosave

remove

public boolean remove(Result result)

Removes a top-level result (i.e., no Result that are contained in ResultSetResults) from the repository.

Parameters:

result - the Result removed

Returns:

if the Result was removed

getAllResults

public List<Result> getAllResults()

Returns all results (top-level and nested in ResultSetResults) in the repository.

Returns:

the results

getResults

public List<Result> getResults()

Returns only the top-level Results of this repository.

Returns:

the top-level Results

filterByMimeAndExtendedType

public List<Result> filterByMimeAndExtendedType(String mime,
                                                String extendedType)

Returns all Results in the repository that match the filter criteria.

Parameters:

mime - the mime type (or extension) of the Result that are to be returned

extendedType - an extended type, also TextResults with extended type null are returned if they match mime

Returns:

the Results

register

public void register(ResultRepository.ResultConsumer resultConsumer)

Registers a ResultRepository.ResultConsumer to this repository. All ResultRepository.ResultConsumer registered will be notified for changes (additions or removals) in the repository.

Parameters:

resultConsumer - the consumer

getConsumers

public ArrayList<ResultRepository.ResultConsumer> getConsumers()

Returns the list of ResultRepository.ResultConsumers registered for the current ResultRepository.

Returns:

the consumers

restoreResultsFromXML

public void restoreResultsFromXML(StringBuffer sb)
                           throws NonParsableException

Restores the contents of a repository from its XML representation. The restored Results are added to the current contents of the repository.

Parameters:

sb - the XML representation

Throws:

NonParsableException - if the XML could not be parsed

storeResultsToXML

public StringBuffer storeResultsToXML()

Stores the current contents of the repository to an XML representation.

Returns:

the XML representation