Class representing vocabulary entity attribute. More...

Inheritance diagram for cz.vutbr.fit.knot.annotations.entity.attribute.EntityAttribute:

Collaboration diagram for cz.vutbr.fit.knot.annotations.entity.attribute.EntityAttribute:

Classes
class	Entity
	Class holds values of dictionary entity. More...

Public Member Functions
	EntityAttribute ()

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

List< EntityAdditionalAttribute >	getEntityAdditionalAttributes ()

void	setEntityAdditionalAttributes (ArrayList< EntityAdditionalAttribute > EntityAdditionalAttributes)

void	setDescription (String textValue)

String	getDescription ()

void	setEntityName (String name)

String	toXmlString ()

String	toXMLStringWHV2 ()

String	toXMLResponseStringV2 ()

void	setRawValues (Object values) throws IllegalArgumentException

String	getXmlAttributeName ()

Object	getValue ()

void	setValue (Object value)

void	setFromJSONStringValue (String value)

void	setEntityVisualURI (String entityVisualURI)

void	setEntityType (String entityType)

void	setStringValue (String stringValue)

String	toString ()

String	getTypeOntologyUri ()

Public Member Functions inherited from cz.vutbr.fit.knot.annotations.entity.attribute.StructuredAttribute
String	getCommentXmlPart (boolean proto11)

String	toXMLString (boolean proto11, boolean tmpIdForNested, 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.entity.attribute.BaseAttribute
	BaseAttribute ()

	BaseAttribute (Integer id)

String	getTypeOntologyUri ()

String	toXMLString (boolean proto11, boolean tmpIdForNested, boolean withOntology)

String	getValueType ()

String	getTypeUriV2 ()

String	toXMLStringV2 ()

String	toSXMLString ()

EntityAdditionalAttribute	toEntityAdditionalAttribute ()

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	getAnnotation ()

void	setAnnotation (int annotation)

Annotation	getRefAnnotation ()

void	setRefAnnotation (Annotation value)

AnnotType	getAttributeType ()

void	setAttributeType (AnnotType attributeType)

Annotation	getNestedAnnotation ()

String	getNestedID ()

void	setNestedID (String nest)

void	setLinkedID (int link)

void	setNestedAnnotation (Annotation nestedAnnotation)

Annotation	getLinkedAnnotation ()

void	setLinkedAnnotation (Annotation linkedAnnotation)

Integer	getId ()

void	setId (Integer id)

Integer	getType ()

void	setType (Integer type)

boolean	isStructured ()

void	setUser (User user)

void	setUri (String uri)

String	getUri ()

void	setUriInOntology (String uriInOntology)

String	getUriInOntology ()

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 ()

void	setTextValue (String textValue)

Integer	getUserValue ()

Integer	getPriority ()

void	setPriority (Integer priority)

List< EntityAdditionalAttribute >	getEntityAdditionalAttributes ()

String	toJSONString ()

void	updateFromBaseAttributeAll (BaseAttribute ba)

void	updateFromSugBaseAttributeAll (SugBaseAttribute ba)

Protected Member Functions
String	getXmlBody ()

Protected Member Functions inherited from cz.vutbr.fit.knot.annotations.entity.attribute.StructuredAttribute
String	getXmlStart (boolean withOntology)

String	getXmlEnd ()

abstract String	getXmlBody ()

Protected Member Functions inherited from cz.vutbr.fit.knot.annotations.entity.attribute.BaseAttribute
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.entity.attribute.BaseAttribute
Integer	id

int	annotation

String	name

String	simpleType

Integer	type

String	uri

String	nested

Integer	linked

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

Annotation	refAnnotation

AnnotType	attributeType

Annotation	nestedAnnotation

Annotation	linkedAnnotation

User	user

List< EntityAdditionalAttribute >	entityAdditionalAttributes

Static Protected Attributes inherited from cz.vutbr.fit.knot.annotations.entity.attribute.BaseAttribute
static final long	serialVersionUID = 1L

Detailed Description

Class representing vocabulary entity attribute.

Definition at line 41 of file EntityAttribute.java.

Constructor & Destructor Documentation

cz.vutbr.fit.knot.annotations.entity.attribute.EntityAttribute.EntityAttribute ( )

Constructor.

Definition at line 46 of file EntityAttribute.java.

cz.vutbr.fit.knot.annotations.entity.attribute.EntityAttribute.EntityAttribute	(	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 59 of file EntityAttribute.java.

Member Function Documentation

String cz.vutbr.fit.knot.annotations.entity.attribute.EntityAttribute.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 387 of file EntityAttribute.java.

String cz.vutbr.fit.knot.annotations.entity.attribute.EntityAttribute.getDescription ( )

Gets entity description

Returns: Returns entity description

Definition at line 101 of file EntityAttribute.java.

List<EntityAdditionalAttribute> cz.vutbr.fit.knot.annotations.entity.attribute.EntityAttribute.getEntityAdditionalAttributes ( )

Gets additional attributes of this entity

Returns: Returns additional attributes of this entity

Definition at line 74 of file EntityAttribute.java.

String cz.vutbr.fit.knot.annotations.entity.attribute.EntityAttribute.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 494 of file EntityAttribute.java.

Object cz.vutbr.fit.knot.annotations.entity.attribute.EntityAttribute.getValue ( )

Gets attribute value

Returns: Returns attribute value

Definition at line 420 of file EntityAttribute.java.

Here is the caller graph for this function:

String cz.vutbr.fit.knot.annotations.entity.attribute.EntityAttribute.getXmlAttributeName ( )

Gets name of this attribute to XML

Returns: Name of this attribute to XML

Definition at line 410 of file EntityAttribute.java.

String cz.vutbr.fit.knot.annotations.entity.attribute.EntityAttribute.getXmlBody ( )

protected

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

Returns: Returns value of attribute in XML

Definition at line 120 of file EntityAttribute.java.

void cz.vutbr.fit.knot.annotations.entity.attribute.EntityAttribute.setDescription ( String textValue )

Sets entity description

Parameters

textValue New description

Definition at line 92 of file EntityAttribute.java.

void cz.vutbr.fit.knot.annotations.entity.attribute.EntityAttribute.setEntityAdditionalAttributes ( ArrayList< EntityAdditionalAttribute > EntityAdditionalAttributes )

Sets additional attributes of this entity

Parameters

EntityAdditionalAttributes Additional attributes of this entity

Definition at line 83 of file EntityAttribute.java.

void cz.vutbr.fit.knot.annotations.entity.attribute.EntityAttribute.setEntityName ( String name )

Sets entity name

Parameters

name	New entity name

Definition at line 110 of file EntityAttribute.java.

void cz.vutbr.fit.knot.annotations.entity.attribute.EntityAttribute.setEntityType ( String entityType )

Sets type of entity

Parameters

entityType Type of entity

Definition at line 463 of file EntityAttribute.java.

void cz.vutbr.fit.knot.annotations.entity.attribute.EntityAttribute.setEntityVisualURI ( String entityVisualURI )

Sets URI of visual representation of entity

Parameters

entityVisualURI URI of visual representation of entity

Definition at line 454 of file EntityAttribute.java.

void cz.vutbr.fit.knot.annotations.entity.attribute.EntityAttribute.setFromJSONStringValue ( String value )

The method sets the parameters from a string in JSON.

Parameters

value String parsed from JSON

Definition at line 443 of file EntityAttribute.java.

void cz.vutbr.fit.knot.annotations.entity.attribute.EntityAttribute.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 354 of file EntityAttribute.java.

void cz.vutbr.fit.knot.annotations.entity.attribute.EntityAttribute.setStringValue ( String stringValue )

Sets string value of attribute

Parameters

stringValue Gets string value of attribute

Definition at line 472 of file EntityAttribute.java.

void cz.vutbr.fit.knot.annotations.entity.attribute.EntityAttribute.setValue ( Object value )

Sets attribute value

Parameters

value Attribute value (Entity)

Definition at line 430 of file EntityAttribute.java.

String cz.vutbr.fit.knot.annotations.entity.attribute.EntityAttribute.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 484 of file EntityAttribute.java.

String cz.vutbr.fit.knot.annotations.entity.attribute.EntityAttribute.toXMLResponseStringV2 ( )

Method converts the object into an XML string for prupose of protocol version 2.

Returns: XML string that represents this object

Definition at line 281 of file EntityAttribute.java.

Here is the call graph for this function:

String cz.vutbr.fit.knot.annotations.entity.attribute.EntityAttribute.toXmlString ( )

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

Returns: XML string that represents this object

Definition at line 166 of file EntityAttribute.java.

String cz.vutbr.fit.knot.annotations.entity.attribute.EntityAttribute.toXMLStringWHV2 ( )

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

Returns: Returns serialized informations about attribute of annotation in XML

Definition at line 215 of file EntityAttribute.java.

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

src/java/cz/vutbr/fit/knot/annotations/entity/attribute/EntityAttribute.java

Classes

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation