4A Server -  2.0
 All Classes Namespaces Files Functions Variables Enumerator
cz.vutbr.fit.knot.annotations.entity.attribute.StructuredAttribute Class Referenceabstract

Abstract class representing more complex attribute. More...

Inheritance diagram for cz.vutbr.fit.knot.annotations.entity.attribute.StructuredAttribute:
Inheritance graph
Collaboration diagram for cz.vutbr.fit.knot.annotations.entity.attribute.StructuredAttribute:
Collaboration graph

Public Member Functions

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< EntityAdditionalAttributegetEntityAdditionalAttributes ()
 
String toJSONString ()
 
void updateFromBaseAttributeAll (BaseAttribute ba)
 
void updateFromSugBaseAttributeAll (SugBaseAttribute ba)
 

Protected Member Functions

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

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< EntityAdditionalAttributeentityAdditionalAttributes
 
- Static Protected Attributes inherited from cz.vutbr.fit.knot.annotations.entity.attribute.BaseAttribute
static final long serialVersionUID = 1L
 

Detailed Description

Abstract class representing more complex attribute.

Abstract class representing more complex attribute

Definition at line 27 of file StructuredAttribute.java.

Member Function Documentation

String cz.vutbr.fit.knot.annotations.entity.attribute.StructuredAttribute.getCommentXmlPart ( boolean  proto11)

Helper function,which returns XML part for comments.

Parameters
proto11If true, protocol version is greater then 1.0
Returns
XML part for comments

Definition at line 36 of file StructuredAttribute.java.

Here is the caller graph for this function:

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

XML of the structured attribute looks like this:

* <a:attribute ...... >
*     <nested>
*         <value1>...</value1>
*         <value2>...</value2>
*     </nested>
* </a:attribute>
* 
Returns
the name of the "nested" attribute
abstract String cz.vutbr.fit.knot.annotations.entity.attribute.StructuredAttribute.getXmlBody ( )
abstractprotected

XML of the structured attribute looks like this:

* <a:attribute ...... >
*     <nested>
*         <value1>...</value1>
*         <value2>...</value2>
*     </nested>
* </a:attribute>
* 

This method returns the content of the a:attribute element with all nested elements.

Returns
Returns the content of the a:attribute element with all nested elements.

Here is the caller graph for this function:

String cz.vutbr.fit.knot.annotations.entity.attribute.StructuredAttribute.getXmlEnd ( )
protected

XML of the structured attribute looks like this:

* <a:attribute ...... >
*     <nested>
*         <value1>...</value1>
*         <value2>...</value2>
*     </nested>
* </a:attribute>
* 

This method returns the ending element for the a:attribute element.

Returns
Returns the ending element for the a:attribute element.

Definition at line 95 of file StructuredAttribute.java.

Here is the caller graph for this function:

String cz.vutbr.fit.knot.annotations.entity.attribute.StructuredAttribute.getXmlStart ( boolean  withOntology)
protected

XML of the structured attribute looks like this:

* <a:attribute ...... >
*     <nested>
*         <value1>...</value1>
*         <value2>...</value2>
*     </nested>
* </a:attribute>
* 

This method returns the starting element for the a:attribute element.

Parameters
withOntologyIf true, URI in ontology will be serialized, if false, it will be omitted
Returns
Returns the starting element for the a:attribute element.

Definition at line 60 of file StructuredAttribute.java.

Here is the call graph for this function:

Here is the caller graph for this function:

boolean cz.vutbr.fit.knot.annotations.entity.attribute.StructuredAttribute.isStructured ( )

Checks if attribute is structured. Structured attribute is for example GeoPointAttribute

Returns
true, if attribute is structured

Definition at line 157 of file StructuredAttribute.java.

void cz.vutbr.fit.knot.annotations.entity.attribute.StructuredAttribute.setRawValue ( String  value) throws IllegalArgumentException

Parses provided value and sets that value as a value of attribute

This method should not be used because structured attributes are not represented by single value.

Parameters
valuenew value of the attribute in raw form from XML

Definition at line 146 of file StructuredAttribute.java.

abstract void cz.vutbr.fit.knot.annotations.entity.attribute.StructuredAttribute.setRawValues ( Object  values) throws IllegalArgumentException
abstract

Parses provided values and sets that values as a values of the attribute

Parameters
valuesNew values of the attribute in raw forms from XML
String cz.vutbr.fit.knot.annotations.entity.attribute.StructuredAttribute.toXMLString ( boolean  proto11,
boolean  tmpIdForNested,
boolean  withOntology 
)

Returns serialized informations about attribute of annotation in XML

Parameters
proto11If true, protocol version is greater then 1.0
tmpIdForNestedIf true, nested annotations will have attribute tmpId
withOntologyIf true, URI in ontology will be serialized, if false, it will be omittedv
Returns
Returns serialized informations about attribute of annotation in XML

Definition at line 126 of file StructuredAttribute.java.

Here is the call graph for this function:


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