Class representing StoryScope for needs of SEC Interface. More...

Inheritance diagram for cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryScope:

Collaboration diagram for cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryScope:

Public Member Functions
	StoryScope ()

	StoryScope (Integer id, String name, String clientURL)

Integer	getId ()

void	setId (Integer id)

String	getName ()

void	setName (String name)

String	getClientURL ()

void	setClientURL (String clientURL)

List< Object >	getSubscriptions ()

ArrayList< SubscribedSource >	getSubscribedList ()

ArrayList< SubscribedSource >	getUnsubscribedList ()

String	getMessagesAdd ()

String	getMessagesChange ()

String	getMessagesDelete ()

void	deleteMessages ()

void	addSavedMessages (ArrayList< String > messages, int type)

int	hashCode ()

boolean	equals (Object object)

String	toString ()

Static Public Member Functions
static String	messagesToString (ArrayList< String > messages)

Private Member Functions
ArrayList< SubscribedSource >	makeArrayList (List< SubscribedItem > objList)

ArrayList< String >	savedMessagesToAL (List< SavedMessage > savedMessages)

List< SavedMessage >	getSavedMessagesFromDB (int typeOfMessages)

Private Attributes
Integer	id

String	name

String	clientURL

ArrayList< String >	addMessages = null

ArrayList< String >	changeMessages = null

ArrayList< String >	deleteMessages = null

Detailed Description

Class representing StoryScope for needs of SEC Interface.

This class represent StoryScope for needs of SEC Interface.

Author: Martin Petr (xpetrm05)

Definition at line 48 of file StoryScope.java.

Constructor & Destructor Documentation

cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryScope.StoryScope ( )

Constructor

Definition at line 78 of file StoryScope.java.

cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryScope.StoryScope	(	Integer	id,
		String	name,
		String	clientURL
	)

Constructor

Parameters

id	ID of StoryScope
name	name of StoryScope
clientURL	URL address of SEC Client

Definition at line 88 of file StoryScope.java.

Member Function Documentation

void cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryScope.addSavedMessages	(	ArrayList< String >	messages,
		int	type
	)

Add new undelivered messages (one kind of messages) to StoryScope into database

Parameters

messages	list of undelivered messages
type	of messages

Definition at line 253 of file StoryScope.java.

Here is the call graph for this function:

void cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryScope.deleteMessages ( )

Method deletes all messages with annotations for current StoryScope.

Definition at line 225 of file StoryScope.java.

Here is the call graph for this function:

boolean cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryScope.equals ( Object object )

Compares this with other object and returns, whether objects are same type and have same id.

Parameters

object Object to compare with

Returns: If object is same type and have same id, returns true, false otherwise

Definition at line 283 of file StoryScope.java.

String cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryScope.getClientURL ( )

Gets URL addres of SEC Client of StoryScope

Returns: Returns URL address of SEC client of StoryScope

Definition at line 135 of file StoryScope.java.

Here is the caller graph for this function:

Integer cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryScope.getId ( )

Gets id of StoryScope

Returns: Returns id of StoryScope

Definition at line 99 of file StoryScope.java.

Here is the caller graph for this function:

String cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryScope.getMessagesAdd ( )

Gets string with all messages with added annotations for current StoryScope that can't be delivered before.

Returns: String with added annotations messages

Definition at line 198 of file StoryScope.java.

String cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryScope.getMessagesChange ( )

Gets string with all messages with changed annotations for current StoryScope that can't be delivered before.

Returns: String with changed annotations messages

Definition at line 208 of file StoryScope.java.

String cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryScope.getMessagesDelete ( )

Gets string with all messages with deleted annotations for current StoryScope that can't be delivered before.

Returns: String with deleted annotations messages

Definition at line 218 of file StoryScope.java.

String cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryScope.getName ( )

Gets name of StoryScope

Returns: Returns name of StoryScope

Definition at line 117 of file StoryScope.java.

List<SavedMessage> cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryScope.getSavedMessagesFromDB ( int typeOfMessages )

private

Method gets saved messages of specific type (and for current StorySapce) from database.

Parameters

typeOfMessages type of messages that will be returned

Returns: List of saved messages of specific type

Definition at line 378 of file StoryScope.java.

ArrayList<SubscribedSource> cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryScope.getSubscribedList ( )

Gets array list of subscribed sources for StoryScope converted to SubscribeSource objects.

Returns: Array list of subscribed sources

Definition at line 168 of file StoryScope.java.

List<Object> cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryScope.getSubscriptions ( )

Gets list of all subscriptions for StoryScope

Returns: List of subscriptions

Definition at line 153 of file StoryScope.java.

ArrayList<SubscribedSource> cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryScope.getUnsubscribedList ( )

Gets array list of unsubscribed sources for StoryScope converted to SubscribedSource objects.

Returns: Array list of unsubscribed sources

Definition at line 183 of file StoryScope.java.

int cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryScope.hashCode ( )

Definition at line 269 of file StoryScope.java.

ArrayList<SubscribedSource> cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryScope.makeArrayList ( List< SubscribedItem > objList )

private

Method converts list of SubscribedItems to ArrayList of SubscribedSources that is used in SEC module and other parts of server.

Parameters

objList list of SubscribedItems to convert

Returns: Array list of subscriptions

Definition at line 306 of file StoryScope.java.

Here is the call graph for this function:

static String cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryScope.messagesToString ( ArrayList< String > messages )

static

Method convert array strins with messages for StoryScope to one string object that contains all messages.

Parameters

messages list of saved messages to convert

Returns: String with messages all together

Definition at line 362 of file StoryScope.java.

Here is the caller graph for this function:

ArrayList<String> cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryScope.savedMessagesToAL ( List< SavedMessage > savedMessages )

private

Method convert list of saved messages object to list of strings with messages (string representation of messages) for StoryScope.

Parameters

savedMessages list of saved messages to convert

Returns: Array list of strings with messages

Definition at line 343 of file StoryScope.java.

void cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryScope.setClientURL ( String clientURL )

Sets URL addres of SEC Client of StoryScope

Parameters

clientURL URL addres of SEC Client

Definition at line 144 of file StoryScope.java.

void cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryScope.setId ( Integer id )

Sets id of StoryScope

Parameters

id	Id of StoryScope

Definition at line 108 of file StoryScope.java.

void cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryScope.setName ( String name )

Sets name of StoryScope

Parameters

name	Name of StoryScope

Definition at line 126 of file StoryScope.java.

String cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryScope.toString ( )

Definition at line 295 of file StoryScope.java.

Member Data Documentation

ArrayList<String> cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryScope.addMessages = null

private

Array of add messages

Definition at line 67 of file StoryScope.java.

ArrayList<String> cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryScope.changeMessages = null

private

Array of change messages

Definition at line 70 of file StoryScope.java.

String cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryScope.clientURL

private

URL address of SEC Client

Definition at line 64 of file StoryScope.java.

ArrayList<String> cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryScope.deleteMessages = null

private

Array of remove messages

Definition at line 73 of file StoryScope.java.

Integer cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryScope.id

private

ID of StoryScope

Definition at line 54 of file StoryScope.java.

String cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryScope.name

private

Name of StoryScope

Definition at line 59 of file StoryScope.java.

The documentation for this class was generated from the following file:

src/java/cz/vutbr/fit/knot/annotations/modules/StoryscopeInterface/StoryScope.java

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation