Package org.rogatio.circlead.control.synchronizer

Class DefaultSynchronizer

java.lang.Object

org.rogatio.circlead.control.synchronizer.DefaultSynchronizer

All Implemented Interfaces:

ISynchronizer

Direct Known Subclasses:

AtlassianSynchronizer, FileSynchronizer

public class DefaultSynchronizer
extends java.lang.Object
implements ISynchronizer

The Class DefaultSynchronizer.

Author:

Matthias Wegner

Constructor Summary

Constructors

Constructor	Description
DefaultSynchronizer()

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.
boolean	equals(java.lang.Object obj)
IWorkitem	get(java.lang.String filename)	Gets the workitem of named id.
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.
int	hashCode()
java.util.List<java.lang.String>	loadIndex(WorkitemType workitemType)	Load index for all workitems which where found by synchronizer of named workitem-type.
java.lang.String	toString()
SynchronizerResult	update(IWorkitem workitem)	Update workitem on synchronized system.
SynchronizerResult	update(IReport report)	Update report on synchronized system.
void	writeIndex()	Write index.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultSynchronizer

public DefaultSynchronizer()

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

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

Parameters:

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

Returns:

the loaded workitem

Throws:

SynchronizerException - the synchronizer exception

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

Parameters:

workitemType - the workitem type

Returns:

the list of query results of found items

add

public SynchronizerResult add(IWorkitem workitem)
                       throws SynchronizerException

Description copied from interface: ISynchronizer

Adds workitem to synchronized system.

Specified by:

add in interface ISynchronizer

Parameters:

workitem - the workitem to add

Returns:

the synchronizer result of adding item

Throws:

SynchronizerException - the synchronizer exception

update

public SynchronizerResult update(IWorkitem workitem)
                          throws SynchronizerException

Description copied from interface: ISynchronizer

Update workitem on synchronized system.

Specified by:

update in interface ISynchronizer

Parameters:

workitem - the workitem to update

Returns:

the synchronizer result

Throws:

SynchronizerException - the synchronizer exception

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

Returns:

the id pattern

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

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

Returns:

the renderer for the synchronizer

add

public SynchronizerResult add(IReport report)
                       throws SynchronizerException

Description copied from interface: ISynchronizer

Adds the report to synchronized system.

Specified by:

add in interface ISynchronizer

Parameters:

report - the report to add

Returns:

the synchronizer result

Throws:

SynchronizerException - the synchronizer exception

update

public SynchronizerResult update(IReport report)
                          throws SynchronizerException

Description copied from interface: ISynchronizer

Update report on synchronized system.

Specified by:

update in interface ISynchronizer

Parameters:

report - the report to update

Returns:

the synchronizer result for update

Throws:

SynchronizerException - the synchronizer exception

writeIndex

public void writeIndex()

Description copied from interface: ISynchronizer

Write index.

Specified by:

writeIndex in interface ISynchronizer