Class representing vocabulary entity attribute for prupose of suggestion. More...

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

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

Public Member Functions
	SugEntityAttribute ()

	SugEntityAttribute (String name, String type, String URI, String visualRepresentation, String description)

List < SugEntityAdditionalAttribute >	getEntityAdditionalAttributes ()

void	setEntityAdditionalAttributes (ArrayList< SugEntityAdditionalAttribute > EntityAdditionalAttributes)

void	setDescription (String textValue)

String	getDescription ()

void	setEntityName (String name)

String	toXmlString ()

String	toXMLStringWHV2 ()

void	setRawValues (Object values) throws IllegalArgumentException

String	getXmlAttributeName ()

Object	getValue ()

void	setValue (Object value)

void	setStringValue (String value)

String	toString ()

String	getTypeOntologyUri ()

Public Member Functions inherited from cz.vutbr.fit.knot.annotations.modules.suggestionManager.attributes.SugStructuredAttribute
String	getCommentXmlPart (boolean proto11)

String	toXMLString (boolean proto11, boolean withOntology)

void	setRawValue (String value) throws IllegalArgumentException

boolean	isStructured ()

abstract void	setRawValues (Object values) throws IllegalArgumentException

abstract String	getXmlAttributeName ()

String	getTypeOntologyUri ()

Public Member Functions inherited from cz.vutbr.fit.knot.annotations.modules.suggestionManager.attributes.SugBaseAttribute
	SugBaseAttribute ()

	SugBaseAttribute (Integer id)

String	getTypeOntologyUri ()

String	toXMLString (boolean proto11, boolean withOntology)

String	toXMLStringV2 ()

SugEntityAdditionalAttribute	toSugEntityAdditionalAttribute ()

int	compareTo (Object o)

boolean	contentEquals (Object obj)

boolean	contentEquals (Object obj, boolean refAnnot)

abstract Object	getValue ()

abstract void	setValue (Object value)

abstract void	setRawValue (String value) throws IllegalArgumentException

boolean	isEmpty ()

boolean	equals (Object object)

String	getComment ()

void	setComment (String comment)

String	toString ()

int	hashCode ()

String	getName ()

void	setName (String name)

String	getSimpleType ()

void	setSimpleType (String simpleType)

int	getSuggestion ()

void	setSuggestion (int suggestion)

Suggestion	getRefSuggestion ()

void	setRefSuggestion (Suggestion value)

void	setRefSecSuggestion (SecSuggestion value)

AnnotType	getAttributeType ()

void	setAttributeType (AnnotType attributeType)

Suggestion	getNestedSuggestion ()

Annotation	getNestedAnnotation ()

String	getNestedSuggID ()

void	setNestedSuggID (String nest)

String	getNestedAnnotID ()

void	setNestedAnnotID (String nestAnnot)

void	setNestedSuggestion (Suggestion nestedSuggestion)

void	setNestedAnnotation (Annotation nestedAnnotation)

Integer	getId ()

void	setId (Integer id)

Integer	getType ()

void	setType (Integer type)

boolean	isStructured ()

void	setUser (User user)

User	getUser ()

void	setUri (String uri)

String	getUri ()

void	setUriInOntology (String uriInOntology)

String	getUriInOntology ()

String	toJSONString ()

void	updateFromBaseAttribut (BaseAttribute ba)

void	updateFromAlternativeAttribut (AlternativeAttribute attr)

String	getEntityType ()

void	setEntityType (String entityType)

String	getEntityVisualURI ()

void	setEntityVisualURI (String entityVisualURI)

Boolean	getBoolValue ()

byte[]	getBinValue ()

Date	getDateValue ()

BigDecimal	getDecValue ()

BigDecimal	getGeoLat ()

BigDecimal	getGeoLong ()

Integer	getIntValue ()

String	getStringValue ()

String	getTextValue ()

Integer	getUserValue ()

Annotation	getLinkedAnnotation ()

Suggestion	getLinkedSuggestion ()

void	setLinkedSuggestion (Suggestion suggestion)

Integer	getPriority ()

void	setPriority (Integer priority)

List < SugEntityAdditionalAttribute >	getEntityAdditionalAttributes ()

void	setEntityAdditionalAttributes (List< SugEntityAdditionalAttribute > entityAdditionalAttributes)

void	updateFromBaseAttributeAll (SugBaseAttribute ba)

void	setBoolVAlue (Boolean boolVAlue)

Protected Member Functions
String	getXmlBody ()

Protected Member Functions inherited from cz.vutbr.fit.knot.annotations.modules.suggestionManager.attributes.SugStructuredAttribute
String	getXmlStart (boolean withOntology)

String	getXmlEnd ()

abstract String	getXmlBody ()

Protected Member Functions inherited from cz.vutbr.fit.knot.annotations.modules.suggestionManager.attributes.SugBaseAttribute
String	getCommentXmlPart (boolean proto11)

String	xmlFormatValue ()

Private Member Functions
String	escapeHTML (String s)

Additional Inherited Members
Protected Attributes inherited from cz.vutbr.fit.knot.annotations.modules.suggestionManager.attributes.SugBaseAttribute
Integer	id

int	suggestion

String	name

String	simpleType

Integer	type

String	uri

String	nestedSugg

String	nestedAnnot

Integer	linkedSugg

Integer	linkedAnnot

String	stringValue

String	textValue

Date	dateValue

Integer	intValue

BigDecimal	decValue

Boolean	boolVAlue

byte[]	binValue

Integer	userValue

BigDecimal	geoLat

BigDecimal	geoLong

String	entityType

String	entityVisualURI

String	comment

Integer	priority

Suggestion	refSuggestion

AnnotType	attributeType

Suggestion	nestedSuggestion

Annotation	nestedAnnotation

Suggestion	linkedSuggestion

Annotation	linkedAnnotation

User	user

List < SugEntityAdditionalAttribute >	entityAdditionalAttributes

Static Protected Attributes inherited from cz.vutbr.fit.knot.annotations.modules.suggestionManager.attributes.SugBaseAttribute
static final long	serialVersionUID = 1L

Detailed Description

Class representing vocabulary entity attribute for prupose of suggestion.

Class representing vocabulary entity attribute for prupose of suggestion

Definition at line 41 of file SugEntityAttribute.java.

Constructor & Destructor Documentation

cz.vutbr.fit.knot.annotations.modules.suggestionManager.attributes.SugEntityAttribute.SugEntityAttribute ( )

Constructor.

Definition at line 45 of file SugEntityAttribute.java.

cz.vutbr.fit.knot.annotations.modules.suggestionManager.attributes.SugEntityAttribute.SugEntityAttribute	(	String	name,
		String	type,
		String	URI,
		String	visualRepresentation,
		String	description
	)

Constructor.

Parameters

name	name of vocabulary entity
type	type of vocabulary entity
URI	uri of vocabulary entity
visualRepresentation	uri of visual representation of vocabulary entity
description	description of vocabulary entity

Definition at line 58 of file SugEntityAttribute.java.

Member Function Documentation

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.attributes.SugEntityAttribute.escapeHTML ( String s )

private

The method converts HTML forbidden symbols to their safe version.

Parameters

s	string that contains forbiden symbols

Returns: HTML safe string

Definition at line 311 of file SugEntityAttribute.java.

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.attributes.SugEntityAttribute.getDescription ( )

Gets entity description

Returns: Returns entity description

Definition at line 100 of file SugEntityAttribute.java.

List<SugEntityAdditionalAttribute> cz.vutbr.fit.knot.annotations.modules.suggestionManager.attributes.SugEntityAttribute.getEntityAdditionalAttributes ( )

Gets additional attributes of this entity

Returns: Returns additional attributes of this entity

Definition at line 73 of file SugEntityAttribute.java.

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.attributes.SugEntityAttribute.getTypeOntologyUri ( )

Gets URI addres in ontology for this type of attribute

Returns: Return URI addres in ontology for this type of attribute.

Definition at line 391 of file SugEntityAttribute.java.

Object cz.vutbr.fit.knot.annotations.modules.suggestionManager.attributes.SugEntityAttribute.getValue ( )

Gets attribute value

Returns: Returns attribute value

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

Definition at line 344 of file SugEntityAttribute.java.

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.attributes.SugEntityAttribute.getXmlAttributeName ( )

Gets name of this attribute to XML

Returns: Name of this attribute to XML

Definition at line 334 of file SugEntityAttribute.java.

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.attributes.SugEntityAttribute.getXmlBody ( )

protected

Gets value of attribute in XML (serailized informationa about entity)

Returns: Returns value of attribute in XML

Definition at line 119 of file SugEntityAttribute.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.attributes.SugEntityAttribute.setDescription ( String textValue )

Sets entity description

Parameters

textValue New description

Definition at line 91 of file SugEntityAttribute.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.attributes.SugEntityAttribute.setEntityAdditionalAttributes ( ArrayList< SugEntityAdditionalAttribute > EntityAdditionalAttributes )

Sets additional attributes of this entity

Parameters

EntityAdditionalAttributes Additional attributes of this entity

Definition at line 82 of file SugEntityAttribute.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.attributes.SugEntityAttribute.setEntityName ( String name )

Sets entity name

Parameters

name	New entity name

Definition at line 109 of file SugEntityAttribute.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.attributes.SugEntityAttribute.setRawValues ( Object values ) throws IllegalArgumentException

Sets value of attribute using given parameters from raw input

Parameters

values Parameters from raw input

Exceptions

IllegalArgumentException

Definition at line 278 of file SugEntityAttribute.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.attributes.SugEntityAttribute.setStringValue ( String value )

The method sets the parameters from a string in JSON.

Parameters

value string parsed from JSON

Definition at line 367 of file SugEntityAttribute.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.attributes.SugEntityAttribute.setValue ( Object value )

Sets attribute value

Parameters

value Attribute value (Entity)

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

Definition at line 354 of file SugEntityAttribute.java.

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

Encode values of the attribute to one string

This method can be used for generating value for JSON object

Returns: Encoded values of the attribute in one string

Definition at line 381 of file SugEntityAttribute.java.

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.attributes.SugEntityAttribute.toXmlString ( )

Method converts the object into an XML string (for protocol 1.x).

Returns: XML string that represents this object

Definition at line 161 of file SugEntityAttribute.java.

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.attributes.SugEntityAttribute.toXMLStringWHV2 ( )

Returns serialized informations about attribute of suggestion in XML for protocol v. 2.0 without header (target and attribute specification triples)

Returns: Returns serialized informations about attribute of suggestion in XML

Definition at line 210 of file SugEntityAttribute.java.

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

src/java/cz/vutbr/fit/knot/annotations/modules/suggestionManager/attributes/SugEntityAttribute.java

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation