cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr Class Reference

Class representing attribute of type of annotation. More...

Inheritance diagram for cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr:

Collaboration diagram for cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr:

Public Member Functions
	AnnotTypeAttr ()
	AnnotTypeAttr (Integer id)
	AnnotTypeAttr (AnnotType annotationType, String name, String simpleType, Boolean required)
	AnnotTypeAttr (AnnotType annotationType, String name, String simpleType, Boolean required, Integer priority)
	AnnotTypeAttr (AnnotType annotationType, String name, AnnotType structuredType, Boolean required)
	AnnotTypeAttr (AnnotTypeAttr annotTypeAttr)
Integer	getId ()
void	setId (Integer id)
int	getAnnotType ()
void	setAnnotType (int annotType)
String	getName ()
void	setName (String name)
String	getSimpleType ()
void	setSimpleType (String simpleType)
Integer	getType ()
void	setType (Integer type)
AnnotType	getAnnotationType ()
void	setAnnotationType (AnnotType annotationType)
AnnotType	getAttributeType ()
void	setAttributeType (AnnotType attributeType)
Boolean	getRequired ()
void	setRequired (Boolean required)
String	getUriInOntology ()
void	setUriInOntology (String uriInOntology)
String	getComment ()
void	setComment (String comment)
Integer	getPriority ()
void	setPriority (Integer priority)
int	compareTo (Object o)
int	hashCode ()
boolean	equals (Object object)
boolean	contentEquals (Object obj)
String	toString ()
String	toXMLString (boolean withComment)
String	getValueType ()
String	getTypeUriV2 ()
String	toXMLStringV2 (boolean withComment)

Protected Attributes
Integer	priority

Private Member Functions
String	simpleTypeToString (boolean withComment)

Private Attributes
Integer	id
int	annotType
String	name
String	simpleType
Integer	type
Boolean	required
String	uriInOntology
String	comment
AnnotType	annotationType
AnnotType	attributeType

Static Private Attributes
static final long	serialVersionUID = 1L

Detailed Description

Class representing attribute of type of annotation.

Class representing attribute of type of annotation

Author

idytrych

Definition at line 50 of file AnnotTypeAttr.java.

Constructor & Destructor Documentation

cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.AnnotTypeAttr

(

)

Constructor

Definition at line 104 of file AnnotTypeAttr.java.

cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.AnnotTypeAttr

(

Integer

id

)

Constructor

Parameters

id	id of attribute of type of annotation

Definition at line 112 of file AnnotTypeAttr.java.

cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.AnnotTypeAttr	(	AnnotType	annotationType,
		String	name,
		String	simpleType,
		Boolean	required
	)

Constructor of attribute of simple type

Parameters

annotationType	Type of annotation to which this attribute belongs
name	Name of attribute
simpleType	Name of simple type of attribute
required	Indicator whether this attribute is required

Definition at line 124 of file AnnotTypeAttr.java.

cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.AnnotTypeAttr	(	AnnotType	annotationType,
		String	name,
		String	simpleType,
		Boolean	required,
		Integer	priority
	)

Constructor of attribute of simple type

Parameters

annotationType	Type of annotation to which this attribute belongs
name	Name of attribute
simpleType	Name of simple type of attribute
required	Indicator whether this attribute is required
priority	Priority of attribute

Definition at line 144 of file AnnotTypeAttr.java.

cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.AnnotTypeAttr	(	AnnotType	annotationType,
		String	name,
		AnnotType	structuredType,
		Boolean	required
	)

Constructor of attribute of structured type

Parameters

annotationType	Type of annotation to which this attribute belongs
name	Name of attribute
structuredType	Type of structured attribute (type of annotation)
required	Indicator whether this attribute is required

Definition at line 164 of file AnnotTypeAttr.java.

cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.AnnotTypeAttr

(

AnnotTypeAttr

annotTypeAttr

)

Constructor of attribute of structured type that is inicialized from another attribute.

Parameters

annotTypeAttr

another attribute

Definition at line 181 of file AnnotTypeAttr.java.

Member Function Documentation

int cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.compareTo

(

Object

o

)

Compares attributes according to priority

Parameters

o	Object to compare with

Returns

Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Definition at line 400 of file AnnotTypeAttr.java.

Here is the call graph for this function:

boolean cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.contentEquals

(

Object

obj

)

Compares this with other object and returns, whether objects are same type and have same content (id is irelevant).

Parameters

obj	Object to compare with

Returns

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

Definition at line 453 of file AnnotTypeAttr.java.

boolean cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.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 435 of file AnnotTypeAttr.java.

AnnotType cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.getAnnotationType

(

)

Gets type of annotation to which this attribute belongs

Returns

Returns type of annotation to which this attribute belongs

Definition at line 288 of file AnnotTypeAttr.java.

Here is the caller graph for this function:

int cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.getAnnotType

(

)

Gets id of type of annotation to which this attribute belongs

Returns

Returns id of type of annotation to which this attribute belongs

Definition at line 214 of file AnnotTypeAttr.java.

AnnotType cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.getAttributeType

(

)

Gets type of attribute in case that this is attribute of structured type (type of annotation)

Returns

If type of attribute is structured, returns type of annotation, else returns null

Definition at line 307 of file AnnotTypeAttr.java.

Here is the caller graph for this function:

String cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.getComment

(

)

Gets textual comment

Returns

Returns textual comment

Definition at line 361 of file AnnotTypeAttr.java.

Integer cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.getId

(

)

Gets id of attribute of type of annotation

Returns

Returns id of attribute of type of annotation

Definition at line 196 of file AnnotTypeAttr.java.

Here is the caller graph for this function:

String cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.getName

(

)

Gets name of attribute of type of annotation

Returns

Returns name of attribute of type of annotation

Definition at line 232 of file AnnotTypeAttr.java.

Here is the caller graph for this function:

Integer cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.getPriority

(

)

Gets attribute priority

Returns

Returns attribute priority

Definition at line 379 of file AnnotTypeAttr.java.

Here is the caller graph for this function:

Boolean cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.getRequired

(

)

Gets indicator whether this attribute is required

Returns

If this attribute is required, returns true, false otherwise

Definition at line 325 of file AnnotTypeAttr.java.

Here is the caller graph for this function:

String cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.getSimpleType

(

)

Gets name of simple type of annotation

Returns

If type of attribute is simple, returns name of type, else returns ""

Definition at line 250 of file AnnotTypeAttr.java.

Integer cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.getType

(

)

Gets id of type of attribute in case that this is attribute of structured type (type of annotation)

Returns

If type of attribute is structured, returns id of type of annotation, else returns null

Definition at line 269 of file AnnotTypeAttr.java.

String cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.getTypeUriV2

(

)

Gets URI of type of attribute for protocol v. 2.0

Returns

REturns URI of type of attribute for protocol v. 2.0

Definition at line 575 of file AnnotTypeAttr.java.

Here is the caller graph for this function:

String cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.getUriInOntology

(

)

Gets URI in original ontology

Returns

Returns URI in original ontology

Definition at line 343 of file AnnotTypeAttr.java.

Here is the caller graph for this function:

String cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.getValueType

(

)

Gets type of value of attribute for protocol v. 2.0

Returns

Returns type of value of attribute for protocol v 2.0

Definition at line 557 of file AnnotTypeAttr.java.

Here is the caller graph for this function:

int cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.hashCode

(

)

Definition at line 421 of file AnnotTypeAttr.java.

void cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.setAnnotationType

(

AnnotType

annotationType

)

Sets type of annotation to which this attribute belongs

Parameters

annotationType

Type of annotation to which this attribute belongs

Definition at line 297 of file AnnotTypeAttr.java.

void cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.setAnnotType

(

int

annotType

)

Sets id of type of annotation to which this attribute belongs

Parameters

annotType

id of type of annotation to which this attribute belongs

Definition at line 223 of file AnnotTypeAttr.java.

void cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.setAttributeType

(

AnnotType

attributeType

)

Sets structured type of attribute (only for attribute of structured type)

Parameters

attributeType

Structured type of attribute (type of annotation), or null for simple type

Definition at line 316 of file AnnotTypeAttr.java.

void cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.setComment

(

String

comment

)

Sets textual comment

Parameters

comment

Textual comment

Definition at line 370 of file AnnotTypeAttr.java.

void cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.setId

(

Integer

id

)

Sets id of attribute of type of annotation

Parameters

id	Id of attribute of type of annotation

Definition at line 205 of file AnnotTypeAttr.java.

void cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.setName

(

String

name

)

Sets name of attribute of type of annotation

Parameters

name	Name of attribute of type of annotation

Definition at line 241 of file AnnotTypeAttr.java.

void cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.setPriority

(

Integer

priority

)

Sets attribute priority

Parameters

priority

Attribute priority

Definition at line 388 of file AnnotTypeAttr.java.

void cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.setRequired

(

Boolean

required

)

Sets indicator whether this attribute is required

Parameters

required

If this attribute is required, then true, false otherwise

Definition at line 334 of file AnnotTypeAttr.java.

void cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.setSimpleType

(

String

simpleType

)

Sets name of simple type of annotation (only for attributes of simple type)

Parameters

simpleType

Name of simple type of annotation ("" for structured type)

Definition at line 259 of file AnnotTypeAttr.java.

void cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.setType

(

Integer

type

)

Sets id of type of attribute in case that this is attribute of structured type (type of annotation)

Parameters

type	id of type of attribute in case that this is attribute of structured type

Definition at line 279 of file AnnotTypeAttr.java.

void cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.setUriInOntology

(

String

uriInOntology

)

Sets URI in original ontology

Parameters

uriInOntology

URI in original ontology

Definition at line 352 of file AnnotTypeAttr.java.

String cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.simpleTypeToString ( boolean  withComment )

private

Returns serialized informations about attribute of simple type in XML

Parameters

withComment

If true, comment will be serialized, if false, it will be omitted

Returns

Returns serialized informations about attribute of simple type in XML

Definition at line 502 of file AnnotTypeAttr.java.

Here is the call graph for this function:

String cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.toString

(

)

Definition at line 492 of file AnnotTypeAttr.java.

String cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.toXMLString

(

boolean

withComment

)

Returns serialized informations about attribute of type of annotation in XML

Parameters

withComment

If true, comment will be serialized, if false, it will be omitted

Returns

Returns serialized informations about attribute of type of annotation in XML

Definition at line 532 of file AnnotTypeAttr.java.

Here is the caller graph for this function:

String cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.toXMLStringV2

(

boolean

withComment

)

Returns serialized informations about attribute of type of annotation in XML

Parameters

withComment

If true, comment will be serialized, if false, it will be omitted

Returns

Returns serialized informations about attribute of type of annotation in XML

Definition at line 590 of file AnnotTypeAttr.java.

Member Data Documentation

AnnotType cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.annotationType

private

Type of annotation to which this attribute belongs

Definition at line 95 of file AnnotTypeAttr.java.

int cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.annotType

private

Id of type of annotation to which this attribute belongs

Definition at line 61 of file AnnotTypeAttr.java.

AnnotType cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.attributeType

private

Type of attribute in case that this is attribute of structured type (type of annotation)

Definition at line 99 of file AnnotTypeAttr.java.

String cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.comment

private

Comment

Definition at line 87 of file AnnotTypeAttr.java.

Integer cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.id

private

Id of attribute of type of annotation

Definition at line 57 of file AnnotTypeAttr.java.

String cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.name

private

Name of attribute

Definition at line 65 of file AnnotTypeAttr.java.

Integer cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.priority

protected

Attribute priority (for order)

Definition at line 90 of file AnnotTypeAttr.java.

Boolean cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.required

private

Indicates whether this attribute is required

Definition at line 78 of file AnnotTypeAttr.java.

final long cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.serialVersionUID = 1L

staticprivate

Definition at line 51 of file AnnotTypeAttr.java.

String cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.simpleType

private

Name of simple type of attribute

Definition at line 68 of file AnnotTypeAttr.java.

Integer cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.type

private

Id of type of attribute in case that this is attribute of structured type (type of annotation)

Definition at line 74 of file AnnotTypeAttr.java.

String cz.vutbr.fit.knot.annotations.entity.AnnotTypeAttr.uriInOntology

private

URI in original ontology

Definition at line 82 of file AnnotTypeAttr.java.

---

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

• src/java/cz/vutbr/fit/knot/annotations/entity/AnnotTypeAttr.java