Class representing suggestion of annotation. More...

Inheritance diagram for cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion:

Collaboration diagram for cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion:

Public Member Functions
	Suggestion ()

	Suggestion (Integer id)

	Suggestion (Annotation a)

	Suggestion (Alternative a)

	Suggestion (AnnotType type, String content, String nestedIn)

	Suggestion (Integer id, String authorIdStr, String authorName, String authorAddress, AnnotDocument sourceDocument, String content, String nestedIn)

	Suggestion (AnnotType annotType, Date created, String authorIdStr, String authorName, String authorAddress, AnnotDocument sourceDocument, String content)

	Suggestion (AnnotType annotType, Date created, String authorIdStr, String authorName, String authorAddress, AnnotDocument sourceDocument, String content, Suggestion nestedInAnnot)

void	updateWithSuggestion (Suggestion newData)

void	updateWithAnnotation (Annotation newData)

final void	updateWithAnnotationForDB (Annotation newData)

Integer	getId ()

void	setId (Integer id)

AnnotType	getAnnotType ()

void	setAnnotType (AnnotType annotType)

Date	getCreated ()

void	setCreated (Date created)

User	getUser ()

void	setUser (User user)

String	getAuthorIdStr ()

void	setAuthorIdStr (String authorIdStr)

String	getAuthorName ()

void	setAuthorName (String authorName)

String	getAuthorAddress ()

void	setAuthorAddress (String authorAddress)

String	getSource ()

void	setSource (String source)

Integer	getSourceDocumentId ()

void	setSourceDocumentId (Integer sourceDocumentId)

Integer	getType ()

void	setType (Integer type)

String	getContent ()

void	setContent (String content)

String	getAutorId ()

void	setAutorId (String autorId)

AnnotDocument	getSourceDocument ()

void	setSourceDocument (AnnotDocument sourceDocument)

String	getNestedIn ()

void	setNestedIn (String nestedIn)

List< SugBaseAttribute >	getAttributes ()

void	setAttributes (ArrayList< SugBaseAttribute > attributes)

void	addAttribute (SugBaseAttribute attribute)

List< SuggestionFragment >	getFragments ()

ArrayList< SuggestionFragment >	getFragmentsAL ()

void	setFragments (ArrayList< SuggestionFragment > fragments)

Suggestion	getNestedInSuggestion ()

void	setNestedInSuggestion (Suggestion nestedInSuggestion)

Suggestion	getAlternativeOfSuggestion ()

void	setAlternativeOfSuggestion (Suggestion alternativeOfSuggestion)

Annotation	getNestedInAnnot ()

void	setNestedInAnnot (Annotation nestedInAnnot)

Integer	getConfidence ()

void	setConfidence (Integer confidence)

boolean	getDisplayConfidence ()

void	setDisplayConfidence (boolean displayConfidence)

String	getTmpId ()

void	setTmpId (String tmpId)

boolean	getIsFromSECAPI ()

void	setIsFromSECAPI (boolean isFromSECAPI)

String	getSAEntityIdentifier ()

void	setSAEntityIdentifier (String SAEntityIdentifier)

void	addFragment (SuggestionFragment fragment)

void	addSecFragment (SecFragment fragment)

int	hashCode ()

String	getURIV2 ()

String	getFragmentXpointersV2 ()

String	toXMLStringV2 (ArrayList< String > attFilter, int langNum, Boolean KBRefMode)

String	getFragmentXpointers ()

String	toXMLString (boolean proto11)

String	toXMLString (boolean annotTag, String annotTagAttrs, boolean proto11)

String	fragmentsToXMLString ()

String	attributesToXMLString (boolean proto11)

boolean	equals (Object object)

boolean	equals (Object object, boolean noLinked)

boolean	contentEquals (Object obj)

boolean	contentEquals (Object obj, boolean withCreated, boolean noLinked)

String	toString ()

String	getURI ()

Private Member Functions
void	updateWithAlternativeForDB (Alternative newData)

StringBuilder	attributesToKBRefString (ArrayList< String > attFilter, int langNum)

Private Attributes
Integer	id

int	type

Date	created

String	authorIdStr

String	authorName

String	authorAddress

String	source

int	sourceDocumentId

String	content

Integer	confidence

boolean	displayConfidence

String	autorId

String	nestedIn

String	alternativeOf

AnnotType	annotType

AnnotDocument	sourceDocument

List< SugBaseAttribute >	attributes

List< SuggestionFragment >	fragments

User	user

Suggestion	nestedInSuggestion

Suggestion	alternativeOfSuggestion

boolean	isFromSECAPI

String	SAEntityIdentifier

String	tmpId

Annotation	nestedInAnnot

Static Private Attributes
static final long	serialVersionUID = 1L

Detailed Description

Class representing suggestion of annotation.

Class representing suggestion of annotation

Author: Martin Petr (xpetrm05)

Definition at line 87 of file Suggestion.java.

Constructor & Destructor Documentation

cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.Suggestion ( )

Constructor

Definition at line 223 of file Suggestion.java.

cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.Suggestion ( Integer id )

Constructor of reference objects for searching purposes - no initialization needed

Parameters

id	Id of suggestion

Definition at line 232 of file Suggestion.java.

cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.Suggestion ( Annotation a )

Constructor for creating suggestion from annotation

Parameters

a	Annotation from which is the suggestion created

Definition at line 241 of file Suggestion.java.

cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.Suggestion ( Alternative a )

Constructor for creating suggestion from alternative.

Parameters

a	Alternative from which is the suggestion created

Definition at line 251 of file Suggestion.java.

cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.Suggestion	(	AnnotType	type,
		String	content,
		String	nestedIn
	)

Constructor

Parameters

type	Type of suggestion
content	Textual content of suggestion
nestedIn	If this suggestion is nested, then parent suggestion, null otherwise

Definition at line 263 of file Suggestion.java.

cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.Suggestion	(	Integer	id,
		String	authorIdStr,
		String	authorName,
		String	authorAddress,
		AnnotDocument	sourceDocument,
		String	content,
		String	nestedIn
	)

Constructor

Parameters

id	Id of suggestion
authorIdStr	URI of suggestion author (user)
authorName	Name of suggestion author (user)
authorAddress	E-mail of suggestion author (user)
sourceDocument	Annotated copy of document to which this suggestion belongs
content	Textual content of suggestion
nestedIn	If this suggestion is nested, then parent suggestion, null otherwise

Definition at line 284 of file Suggestion.java.

cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.Suggestion	(	AnnotType	annotType,
		Date	created,
		String	authorIdStr,
		String	authorName,
		String	authorAddress,
		AnnotDocument	sourceDocument,
		String	content
	)

Constructor

Parameters

annotType	Type of suggestion
created	Date of creation
authorIdStr	URI of suggestion author (user)
authorName	Name of suggestion author (user)
authorAddress	E-mail of suggestion author (user)
sourceDocument	Annotated copy of document to which this suggestion belongs
content	Textual content of suggestion

Definition at line 313 of file Suggestion.java.

cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.Suggestion	(	AnnotType	annotType,
		Date	created,
		String	authorIdStr,
		String	authorName,
		String	authorAddress,
		AnnotDocument	sourceDocument,
		String	content,
		Suggestion	nestedInAnnot
	)

Constructor

Parameters

annotType	Type of suggestion
created	Date of creation
authorIdStr	URI of suggestion author (user)
authorName	Name of suggestion author (user)
authorAddress	E-mail of suggestion author (user)
sourceDocument	Annotated copy of document to which this suggestion belongs
content	Textual content of suggestion
nestedInAnnot	If this suggestion is nested, then parent suggestion, null otherwise

Definition at line 343 of file Suggestion.java.

Member Function Documentation

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.addAttribute ( SugBaseAttribute attribute )

Adds an attribute to list of suggestion attributes

Parameters

attribute Attribute to add

Definition at line 835 of file Suggestion.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.addFragment ( SuggestionFragment fragment )

Adds fragment to the list of suggested fragments

Parameters

fragment Suggested fragment

Definition at line 1022 of file Suggestion.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.addSecFragment ( SecFragment fragment )

Adds fragment to the list of suggested fragments

Parameters

fragment Suggested fragment

Implements cz.vutbr.fit.knot.annotations.modules.suggestionManager.alternative.SecSuggestion.

Definition at line 1032 of file Suggestion.java.

StringBuilder cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.attributesToKBRefString	(	ArrayList< String >	attFilter,
		int	langNum
	)

private

Returns serialized attributes in KB Ref mode

Parameters

attFilter	Filter for attributes
langNum	Number of language

Returns: Returns serialized attributes in KB Ref mode

Definition at line 1252 of file Suggestion.java.

Here is the call graph for this function:

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.attributesToXMLString ( boolean proto11 )

Returns serialized informations about suggestion attributes in XML

Parameters

proto11 If true, protocol version is greather then 1.0

Returns: Returns serialized informations about suggestion attributes in XML

Definition at line 1456 of file Suggestion.java.

Here is the call graph for this function:

boolean cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.contentEquals ( Object obj )

Compares this with other object and returns, whether objects are same type and have same content (id is irelevant). Contents of fragments and attributes are also compared.

Parameters

obj	Object to compare with

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

Definition at line 1560 of file Suggestion.java.

Here is the caller graph for this function:

boolean cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.contentEquals	(	Object	obj,
		boolean	withCreated,
		boolean	noLinked
	)

Compares this with other object and returns, whether objects are same type and have same content (id is irrelevant). Contents of fragments and attributes are also compared.

Parameters

obj	Object to compare with
withCreated	If true, dates of creation will be compared, if false, dates will be omitted
noLinked	If true, links in attributes will be omitted, if false, links will be compared

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

Definition at line 1574 of file Suggestion.java.

Here is the call graph for this function:

boolean cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.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 1508 of file Suggestion.java.

boolean cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.equals	(	Object	object,
		boolean	noLinked
	)

Compares this with other object and returns, whether objects are same type and have same id, but not go to deeper comparation if noLinked is set to true.

Parameters

object	Object to compare with
noLinked	No trace links and compare them if is set to true

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

Definition at line 1534 of file Suggestion.java.

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.fragmentsToXMLString ( )

Returns serialized informations about suggested fragments in XML

Returns: Returns serialized informations about suggested fragments in XML

Definition at line 1439 of file Suggestion.java.

Suggestion cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.getAlternativeOfSuggestion ( )

Gets suggestion which alternative is this suggestion

Returns: Gets suggestion which alternative is this suggestion or null

Definition at line 891 of file Suggestion.java.

AnnotType cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.getAnnotType ( )

Gets type of suggestion

Returns: Returns type of suggestion

Definition at line 569 of file Suggestion.java.

Here is the caller graph for this function:

List<SugBaseAttribute> cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.getAttributes ( )

Gets list of suggestion attributes

Returns: Returns list of suggestion attributes

Definition at line 817 of file Suggestion.java.

Here is the caller graph for this function:

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.getAuthorAddress ( )

Gets e-mail of author of suggestion (user)

Returns: Returns e-mail of author of suggestion (user)

Definition at line 669 of file Suggestion.java.

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.getAuthorIdStr ( )

Gets URI of author of suggestion (user)

Returns: Returns URI of author of suggestion (user)

Definition at line 633 of file Suggestion.java.

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.getAuthorName ( )

Gets name of author of suggestion (user)

Returns: Returns name of author of suggestion (user)

Definition at line 651 of file Suggestion.java.

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.getAutorId ( )

Gets id of suggestion author (user)

Returns: Returns id of suggestion author (user)

Definition at line 759 of file Suggestion.java.

Integer cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.getConfidence ( )

Gets confidence of this suggestion

Returns: Returns confidence of this suggestion

Definition at line 927 of file Suggestion.java.

Here is the caller graph for this function:

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.getContent ( )

Gets textual content of suggestion

Returns: Returns textual content of suggestion

Definition at line 741 of file Suggestion.java.

Here is the caller graph for this function:

Date cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.getCreated ( )

Gets date of creation

Returns: Returns date of creation

Definition at line 587 of file Suggestion.java.

boolean cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.getDisplayConfidence ( )

Returns whether should be confidence displayed

Returns: Returns whether should be confidence displayed

Definition at line 945 of file Suggestion.java.

List<SuggestionFragment> cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.getFragments ( )

Gets list of suggested fragments

Returns: Returns list of suggested fragments

Implements cz.vutbr.fit.knot.annotations.modules.suggestionManager.alternative.SecSuggestion.

Definition at line 845 of file Suggestion.java.

Here is the caller graph for this function:

ArrayList<SuggestionFragment> cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.getFragmentsAL ( )

Gets list of suggested fragments as ArrayList

Returns: Returns list of suggested fragments as ArrayList

Definition at line 854 of file Suggestion.java.

Here is the caller graph for this function:

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.getFragmentXpointers ( )

Returns xpointers of all suggestion fragments

Returns: Returns xpointers of all suggestion fragments

Definition at line 1356 of file Suggestion.java.

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.getFragmentXpointersV2 ( )

Returns xpointers of all suggestion fragments

Returns: Returns xpointers of all suggestion fragments

Definition at line 1062 of file Suggestion.java.

Integer cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.getId ( )

Gets id of suggestion

Returns: Returns id of suggestion

Definition at line 551 of file Suggestion.java.

Here is the caller graph for this function:

boolean cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.getIsFromSECAPI ( )

Gets isFromSECAPI

Returns: isFromSECAPI

Definition at line 983 of file Suggestion.java.

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.getNestedIn ( )

Gets URI of suggestion in which is this suggestion nested

Returns: Returns URI of suggestion in which is this suggestion nested

Definition at line 799 of file Suggestion.java.

Here is the caller graph for this function:

Annotation cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.getNestedInAnnot ( )

Gets annotation in which is this suggestion nested

Returns: annotation in which is this suggestion nested

Definition at line 909 of file Suggestion.java.

Here is the caller graph for this function:

Suggestion cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.getNestedInSuggestion ( )

Gets parent suggestion of nested suggestion

Returns: If this suggestion is nested, returns parent suggestion, null otherwise

Definition at line 873 of file Suggestion.java.

Here is the caller graph for this function:

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.getSAEntityIdentifier ( )

Gets SEC API Entity Identifier (to detect same suggestions)

Returns: isFromSECAPI SEC API Entity Identifier

Definition at line 1001 of file Suggestion.java.

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.getSource ( )

Gets annotated copy of document to which this suggestion belongs

Returns: Returns annotated copy of document to which this suggestion belongs

Definition at line 687 of file Suggestion.java.

AnnotDocument cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.getSourceDocument ( )

Gets annotated copy of document to which this suggestion belongs

Returns: Returns annotated copy of document to which this suggestion belongs

Definition at line 777 of file Suggestion.java.

Integer cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.getSourceDocumentId ( )

Gets id of annotated copy of document to which this suggestion belongs

Returns: Returns id of annotated copy of document to which this suggestion belongs

Definition at line 705 of file Suggestion.java.

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.getTmpId ( )

Gets tmpId of this suggestion (warning - tmpId is in id field for suggestion - this is an auxiliary value)

Returns: Returns tmpId of this suggestion

Definition at line 964 of file Suggestion.java.

Here is the caller graph for this function:

Integer cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.getType ( )

Gets id of type of suggestion

Returns: Returns id of type of suggestion

Definition at line 723 of file Suggestion.java.

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.getURI ( )

Gets URI of suggestion

Returns: URI of suggestion

Definition at line 1691 of file Suggestion.java.

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.getURIV2 ( )

Gets URI of suggestion for protocol V2

Returns: URI of suggestion

Definition at line 1050 of file Suggestion.java.

User cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.getUser ( )

Gets author of suggestion (user)

Returns: Returns author of suggestion (user)

Definition at line 605 of file Suggestion.java.

int cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.hashCode ( )

Definition at line 1039 of file Suggestion.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.setAlternativeOfSuggestion ( Suggestion alternativeOfSuggestion )

Sets suggestion which alternative is this suggestion

Parameters

alternativeOfSuggestion Suggestion which alternative is this suggestion

Definition at line 900 of file Suggestion.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.setAnnotType ( AnnotType annotType )

Sets type of suggestion

Parameters

annotType Type of suggestion

Definition at line 578 of file Suggestion.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.setAttributes ( ArrayList< SugBaseAttribute > attributes )

Sets list of suggestion attributes

Parameters

attributes List of suggestion attributes

Definition at line 826 of file Suggestion.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.setAuthorAddress ( String authorAddress )

Sets e-mail of author of suggestion (user)

Parameters

authorAddress E-mail of author of suggestion (user)

Definition at line 678 of file Suggestion.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.setAuthorIdStr ( String authorIdStr )

Sets URI of author of suggestion (user)

Parameters

authorIdStr URI of author of suggestion (user)

Definition at line 642 of file Suggestion.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.setAuthorName ( String authorName )

Sets name of author of suggestion (user)

Parameters

authorName Name of author of suggestion (user)

Definition at line 660 of file Suggestion.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.setAutorId ( String autorId )

Sets id of suggestion author (user)

Parameters

autorId id of suggestion author (user)

Definition at line 768 of file Suggestion.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.setConfidence ( Integer confidence )

Sets confidence of this suggestion

Parameters

confidence Confidence of this suggestion

Definition at line 936 of file Suggestion.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.setContent ( String content )

Sets textual content of suggestion

Parameters

content Textual content of suggestion

Definition at line 750 of file Suggestion.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.setCreated ( Date created )

Sets date of creation

Parameters

created Date of creation

Definition at line 596 of file Suggestion.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.setDisplayConfidence ( boolean displayConfidence )

Sets whether should be confidence displayed

Parameters

displayConfidence Should be confidence displayed?

Definition at line 954 of file Suggestion.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.setFragments ( ArrayList< SuggestionFragment > fragments )

Sets list of suggested fragments

Parameters

fragments List of suggested fragments

Definition at line 863 of file Suggestion.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.setId ( Integer id )

Sets id of suggestion

Parameters

id	Id of suggestion

Definition at line 560 of file Suggestion.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.setIsFromSECAPI ( boolean isFromSECAPI )

Sets isFromSECAPI

Parameters

isFromSECAPI new isFromSECAPI

Definition at line 992 of file Suggestion.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.setNestedIn ( String nestedIn )

Sets URI of suggestion in which is this suggestion nested

Parameters

nestedIn URI of suggestion in which is this suggestion nested

Definition at line 808 of file Suggestion.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.setNestedInAnnot ( Annotation nestedInAnnot )

Sets annotation in which is this suggestion nested

Parameters

nestedInAnnot Annotation in which is this suggestion nested

Definition at line 918 of file Suggestion.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.setNestedInSuggestion ( Suggestion nestedInSuggestion )

Sets parent suggestion of nested suggestion

Parameters

nestedInSuggestion If this suggestion is nested, then parent suggestion, null otherwise

Definition at line 882 of file Suggestion.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.setSAEntityIdentifier ( String SAEntityIdentifier )

Sets SEC API Entity Identifier

Parameters

SAEntityIdentifier SEC API Entity Identifier

Implements cz.vutbr.fit.knot.annotations.modules.suggestionManager.alternative.SecSuggestion.

Definition at line 1011 of file Suggestion.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.setSource ( String source )

Sets annotated copy of document to which this suggestion belongs

Parameters

source Annotated copy of document to which this suggestion belongs

Definition at line 696 of file Suggestion.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.setSourceDocument ( AnnotDocument sourceDocument )

Sets annotated copy of document to which this suggestion belongs (if document is not null, his URI is also set)

Parameters

sourceDocument Annotated copy of document to which this suggestion belongs

Definition at line 787 of file Suggestion.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.setSourceDocumentId ( Integer sourceDocumentId )

Sets id of annotated copy of document to which this suggestion belongs

Parameters

sourceDocumentId id of annotated copy of document to which this suggestion belongs

Definition at line 714 of file Suggestion.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.setTmpId ( String tmpId )

Sets tmpId of this suggestion (warning - tmpId is in id field for suggestion - this is an auxiliary value)

Parameters

tmpId tmpId of this suggestion

Definition at line 974 of file Suggestion.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.setType ( Integer type )

Sets id of type of suggestion

Parameters

type	id of type of suggestion

Definition at line 732 of file Suggestion.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.setUser ( User user )

Sets author of suggestion (user) URI is also set and if available, full name and e-mail too

Parameters

user	Author of suggestion (user)

Definition at line 615 of file Suggestion.java.

Here is the call graph for this function:

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.toString ( )

Definition at line 1682 of file Suggestion.java.

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.toXMLString ( boolean proto11 )

Returns serialized informations about suggestion in XML

Parameters

proto11 If true, protocol version is greather then 1.0

Returns: Returns serialized informations about suggestion in XML

Definition at line 1373 of file Suggestion.java.

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.toXMLString	(	boolean	annotTag,
		String	annotTagAttrs,
		boolean	proto11
	)

Returns serialized informations about suggestion in XML

Parameters

annotTag	Denotes whether wrapping tag suggestion should be included
annotTagAttrs	Attributes of created suggestion tag
proto11	If true, protocol version is greather then 1.0

Returns: Returns serialized informations about suggestion in XML

Definition at line 1385 of file Suggestion.java.

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.toXMLStringV2	(	ArrayList< String >	attFilter,
		int	langNum,
		Boolean	KBRefMode
	)

Returns serialized informations about suggestion in XML for protocol V2

Parameters

attFilter	Filter for attributes
langNum	Number of language
KBRefMode	Is KB_Ref mode on?

Returns: Returns serialized informations about suggestion in XML for protocol V2

Definition at line 1081 of file Suggestion.java.

Here is the call graph for this function:

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.updateWithAlternativeForDB ( Alternative newData )

private

Update data of suggestion with alternative data in correct way to save to db

Parameters

newData Alternative data

Definition at line 438 of file Suggestion.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.updateWithAnnotation ( Annotation newData )

Update data of suggestion with annotation data

Parameters

newData Annotation data

Definition at line 392 of file Suggestion.java.

Here is the call graph for this function:

final void cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.updateWithAnnotationForDB ( Annotation newData )

Update data of suggestion with annotation data in correct way to save to db

Parameters

newData Annotation data

Definition at line 500 of file Suggestion.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.updateWithSuggestion ( Suggestion newData )

Updates data in this suggestion with data from another suggestion

Parameters

newData Suggestion with new data

Definition at line 366 of file Suggestion.java.

Here is the call graph for this function:

Member Data Documentation

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.alternativeOf

private

If this suggestion was created from alternative, here is id of main suggestion

Definition at line 164 of file Suggestion.java.

Suggestion cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.alternativeOfSuggestion

private

If this suggestion was created from alternative, here is id of main suggestion

Definition at line 199 of file Suggestion.java.

AnnotType cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.annotType

private

Type of suggestion

Definition at line 169 of file Suggestion.java.

List<SugBaseAttribute> cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.attributes

private

List of attributes of suggestion

Definition at line 179 of file Suggestion.java.

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.authorAddress

private

E-mail of suggestion author (user)

Definition at line 122 of file Suggestion.java.

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.authorIdStr

private

URI of suggestion author (user)

Definition at line 112 of file Suggestion.java.

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.authorName

private

Name of suggestion author (user)

Definition at line 117 of file Suggestion.java.

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.autorId

private

Id of suggestion author (user)

Definition at line 156 of file Suggestion.java.

Integer cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.confidence

private

Confidence of suggestion

Definition at line 146 of file Suggestion.java.

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.content

private

Textual content of suggestion

Definition at line 141 of file Suggestion.java.

Date cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.created

private

Date of creation

Definition at line 106 of file Suggestion.java.

boolean cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.displayConfidence

private

Should be confidence displayed?

Definition at line 152 of file Suggestion.java.

List<SuggestionFragment> cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.fragments

private

List of suggested fragments

Definition at line 184 of file Suggestion.java.

Integer cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.id

private

Id of suggestion

Definition at line 94 of file Suggestion.java.

boolean cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.isFromSECAPI

private

Is this suggestion from SEC API?

Definition at line 205 of file Suggestion.java.

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.nestedIn

private

If this suggestion is nested, here is id of parent suggestion

Definition at line 160 of file Suggestion.java.

Annotation cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.nestedInAnnot

private

If this suggestion is nested, here is parent annotation

Definition at line 218 of file Suggestion.java.

Suggestion cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.nestedInSuggestion

private

If this suggestion is nested, here is parent suggestion

Definition at line 194 of file Suggestion.java.

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.SAEntityIdentifier

private

Identifier of entity from SEC API (to detect same suggestions on more places)

Definition at line 210 of file Suggestion.java.

final long cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.serialVersionUID = 1L

staticprivate

Definition at line 88 of file Suggestion.java.

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.source

private

URI of annotated copy of document to which this suggestion belongs

Definition at line 129 of file Suggestion.java.

AnnotDocument cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.sourceDocument

private

Annotated copy of document to which this suggestion belongs

Definition at line 174 of file Suggestion.java.

int cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.sourceDocumentId

private

Id of annotated copy of document to which this suggestion belongs

Definition at line 135 of file Suggestion.java.

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.tmpId

private

Temporary id to identify targets of links in suggestions from client

Definition at line 214 of file Suggestion.java.

int cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.type

private

Id of type of annotation

Definition at line 100 of file Suggestion.java.

User cz.vutbr.fit.knot.annotations.modules.suggestionManager.Suggestion.user

private

Author of suggestion (user)

Definition at line 189 of file Suggestion.java.

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

src/java/cz/vutbr/fit/knot/annotations/modules/suggestionManager/Suggestion.java

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation