Skip to content
Alessandro Gubitosi edited this page Jan 16, 2015 · 10 revisions

Default attribute tags.

This file contains the default ontology tag definitions, these offsets represent the default tags used in the objects comprising the ontology and the core objects of this library.
Each entry is a definitions that holds the global identifier of the tag.

Internal offsets

Native identifier

This offset is the primary key of all persistent objects, it doesn't have a specific data type and all objects must have it. This attribute is internal and it is not defined in the ontology.

define val Data type
kTAG_NID _id -

Class

This offset represents the object class name, this string is used to instantiate the correct object once loaded from a container. This attribute is internal and it is not defined in the ontology.

define val Data type
kTAG_CLASS class -

Type

This offset represents a type or category, it must only be used as a key element of a structured property. It is a string which qualifies the structure or structure element. It is used in properties of type kTYPE_SHAPE as the shape type indicator and in [kTYPE_TYPED_LIST](./Types#Typed list) properties to qualify the current element.

define val Data type
kTAG_TYPE type kTYPE_STRING

Language

This tag holds a string which represents a specific language name or code, this tag is generally used as an element of a structure for indicating the element's language. It is a required element of properties of type [kTYPE_LANGUAGE_STRING](./Types#String list by language) and [kTYPE_LANGUAGE_STRINGS](./Types#Strings list by language).

define val Data type
kTAG_LANGUAGE lang kTYPE_STRING

Text

This tag holds a string which represents a text this tag is generally used as an element of a structure for indicating the element's text. It is a required element of properties of type [kTYPE_LANGUAGE_STRING](./Types#String list by language) and [kTYPE_LANGUAGE_STRINGS](./Types#Strings list by language).

define val Data type
kTAG_TEXT text kTYPE_STRING

URL

This tag holds a string which represents an internet address, this tag is generally used to hold an URL.

define val Data type
kTAG_URL url kTYPE_URL

Tag

This tag holds a string which represents a reference to a tag, the latter's native identifier.

define val Data type
kTAG_TAG_REF tag [kTYPE_REF_TAG](./Types#Tag reference)

Term

This tag holds a string which represents a reference to a term, the latter's native identifier.

define val Data type
kTAG_TERM_REF term [kTYPE_REF_TERM](./Types#Term reference)

Node

This tag holds an integer which represents a reference to a node, the latter's native identifier.

define val Data type
kTAG_NODE_REF node [kTYPE_REF_NODE](./Types#Node reference)

Edge

This tag holds a string which represents a reference to an edge, the latter's native identifier.

define val Data type
kTAG_EDGE_REF edge [kTYPE_REF_EDGE](./Types#Edge reference)

User

  • This tag holds a string which represents a reference to a user, the latter's native identifier.
define val Data type
kTAG_USER_REF user [kTYPE_REF_USER](./Types#User reference)

Unit

This tag holds a string which represents a reference to a unit, the latter's native identifier.

define val Data type
kTAG_UNIT_REF unit [kTYPE_REF_UNIT](./Types#Edge reference)

Geometry

This offset represents the geometry of a shape, it is by default an array which can be nested at several levels, depending on the type of geometry. It is used in properties of type kTYPE_SHAPE to provide the shape geometry; incidentally, it is named coordinates so that when used with the kTAG_TYPE tag it forms a GeoJSON object.

| define | val | Data type | Data kind | | :----------------- | :---------- | :--------------------------: | :.........................: | | kTAG_GEOMETRY | geometry | kTYPE_FLOAT | kTYPE_FLOAT |

Radius

This offset represents the radius of a circle shape in meters, it is used in conjuction with kTAG_TYPE and kTAG_GEOMETRY to create a GeoJSON circle shape.

define val Data type
kTAG_RADIUS radius kTYPE_INT

Full text values, weight 10

This offset is automatically filled with all distinct values coming from all properties whose tag has a kind of kTYPE_FULL_TEXT_10, enumerated values will be resolved to the default language label. This field will be indexed for full-text search with weight 10.

define val Data type Data kind
kTAG_FULL_TEXT_10 text-10 kTYPE_STRING kTYPE_LIST

Full text values, weight 6

This offset is automatically filled with all distinct values coming from all properties whose tag has a kind of kTYPE_FULL_TEXT_06, enumerated values will be resolved to the default language label. This field will be indexed for full-text search with weight 06.

define val Data type Data kind
kTAG_FULL_TEXT_06 text-06 kTYPE_STRING kTYPE_LIST

Full text values, weight 3

This offset is automatically filled with all distinct values coming from all properties whose tag has a kind of kTYPE_FULL_TEXT_03, enumerated values will be resolved to the default language label. This field will be indexed for full-text search with weight 03.

define val Data type Data kind
kTAG_FULL_TEXT_10 text-03 kTYPE_STRING kTYPE_LIST