Package org.rogatio.circlead.control.synchronizer.file

Class FileSynchronizer

java.lang.Object

org.rogatio.circlead.control.synchronizer.DefaultSynchronizer

org.rogatio.circlead.control.synchronizer.file.FileSynchronizer

All Implemented Interfaces:

ISynchronizer, IValidator

public class FileSynchronizer
extends DefaultSynchronizer
implements IValidator

The Class FileSynchronizer.

Author:

Matthias Wegner

Constructor Summary

Constructors

Constructor	Description
FileSynchronizer(java.lang.String dataDirectory)	Instantiates a new file synchronizer.

Method Summary

Modifier and Type	Method	Description
SynchronizerResult	add(IWorkitem workitem)	Adds workitem to synchronized system.
SynchronizerResult	add(IReport report)	Adds the report to synchronized system.
java.lang.String	delete(IWorkitem workitem)	Delete workitem in system which is connected through synchronizer.
void	deleteAll()	Delete all.
IWorkitem	get(java.lang.String filename)	Gets the workitem of named id.
java.lang.String	getDataDirectory()	Gets the data directory.
java.lang.String	getIdPattern()	Gets the pattern for valid id as regular expression which is allowed for synchronized system.
ISynchronizerRendererEngine	getRenderer()	Gets the renderer which is used to render workitems and reports for target system.
java.util.List<java.lang.String>	loadIndex(WorkitemType workitemType)	Load index for all workitems which where found by synchronizer of named workitem-type.
void	setDataDirectory(java.lang.String dataDirectory)	Sets the data directory.
SynchronizerResult	update(IWorkitem workitem)	Update workitem on synchronized system.
SynchronizerResult	update(IReport report)	Update report on synchronized system.
java.util.List<ValidationMessage>	validate()	Validation method.
void	writeIndex()	Write index.
void	writeReportRendered(IReport report)	Write report rendered.

Methods inherited from class org.rogatio.circlead.control.synchronizer.DefaultSynchronizer

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FileSynchronizer

public FileSynchronizer(java.lang.String dataDirectory)

Instantiates a new file synchronizer.

Parameters:

dataDirectory - the data directory

Method Detail

getDataDirectory

public java.lang.String getDataDirectory()

Gets the data directory.

Returns:

the data directory

getIdPattern

public java.lang.String getIdPattern()

Description copied from interface: ISynchronizer

Gets the pattern for valid id as regular expression which is allowed for synchronized system.

Specified by:

getIdPattern in interface ISynchronizer

Overrides:

getIdPattern in class DefaultSynchronizer

Returns:

the id pattern

setDataDirectory

public void setDataDirectory(java.lang.String dataDirectory)

Sets the data directory.

Parameters:

dataDirectory - the new data directory

update

public SynchronizerResult update(IWorkitem workitem)

Description copied from interface: ISynchronizer

Update workitem on synchronized system.

Specified by:

update in interface ISynchronizer

Overrides:

update in class DefaultSynchronizer

Parameters:

workitem - the workitem to update

Returns:

the synchronizer result

update

public SynchronizerResult update(IReport report)

Description copied from interface: ISynchronizer

Update report on synchronized system.

Specified by:

update in interface ISynchronizer

Overrides:

update in class DefaultSynchronizer

Parameters:

report - the report to update

Returns:

the synchronizer result for update

add

public SynchronizerResult add(IWorkitem workitem)

Description copied from interface: ISynchronizer

Adds workitem to synchronized system.

Specified by:

add in interface ISynchronizer

Overrides:

add in class DefaultSynchronizer

Parameters:

workitem - the workitem to add

Returns:

the synchronizer result of adding item

add

public SynchronizerResult add(IReport report)

Description copied from interface: ISynchronizer

Adds the report to synchronized system.

Specified by:

add in interface ISynchronizer

Overrides:

add in class DefaultSynchronizer

Parameters:

report - the report to add

Returns:

the synchronizer result

deleteAll

public void deleteAll()

Delete all.

writeReportRendered

public void writeReportRendered(IReport report)

Write report rendered.

Parameters:

report - the report

loadIndex

public java.util.List<java.lang.String> loadIndex(WorkitemType workitemType)

Description copied from interface: ISynchronizer

Load index for all workitems which where found by synchronizer of named workitem-type.

Specified by:

loadIndex in interface ISynchronizer

Overrides:

loadIndex in class DefaultSynchronizer

Parameters:

workitemType - the workitem type

Returns:

the list of query results of found items

get

public IWorkitem get(java.lang.String filename)
              throws SynchronizerException

Description copied from interface: ISynchronizer

Gets the workitem of named id.

Specified by:

get in interface ISynchronizer

Overrides:

get in class DefaultSynchronizer

Parameters:

filename - the workitem of specific synchronizer. Every synchronizer could have own id-logic

Returns:

the loaded workitem

Throws:

SynchronizerException - the synchronizer exception

delete

public java.lang.String delete(IWorkitem workitem)
                        throws SynchronizerException

Description copied from interface: ISynchronizer

Delete workitem in system which is connected through synchronizer.

Specified by:

delete in interface ISynchronizer

Overrides:

delete in class DefaultSynchronizer

Parameters:

workitem - the workitem to delete

Returns:

the result and response of deletion

Throws:

SynchronizerException - the synchronizer exception

getRenderer

public ISynchronizerRendererEngine getRenderer()

Description copied from interface: ISynchronizer

Gets the renderer which is used to render workitems and reports for target system.

Specified by:

getRenderer in interface ISynchronizer

Overrides:

getRenderer in class DefaultSynchronizer

Returns:

the renderer for the synchronizer

validate

public java.util.List<ValidationMessage> validate()

Description copied from interface: IValidator

Validation method. Checks for valid data

Specified by:

validate in interface IValidator

Returns:

list of validation-messages

writeIndex

public void writeIndex()

Description copied from interface: ISynchronizer

Write index.

Specified by:

writeIndex in interface ISynchronizer

Overrides:

writeIndex in class DefaultSynchronizer