org.g_node.nix

Class Property

java.lang.Object

org.bytedeco.javacpp.Pointer

org.g_node.nix.base.ImplContainer

org.g_node.nix.base.Entity

org.g_node.nix.Property

All Implemented Interfaces:

Comparable<Property>

@Platform(include="<nix/Property.hpp>") @Platform(value="linux",link="nix@.1",preload="hdf5@.7") @Platform(value="windows",link="nix",preload={"hdf5","msvcp120","msvcr120","szip","zlib"})
 @Namespace(value="nix")
public class Property
extends Entity
implements Comparable<Property>

Property

Class representing an odML property entity.

In the odML model information is stored in the form of extended key-value pairs. A Property contains information that is valid for all Values stored in it. Its DataType provides information about the type of the stored Value entities (e.g. double or integer).

The setUnit(String) is the unit of the stored values. Similar to the Section entity, mapping information can be provided using the setMapping(String) field.

See Also:

DataType, Section

Constructor Summary

Constructors

Constructor and Description
Property() Constructor that creates an uninitialized Property.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Property property)
void	deleteValues() Deletes all values from the property.
void	forceCreatedAt(Date date) Sets the creation date to the provided value even if the attribute is set.
void	forceUpdatedAt() Sets the time of the last update to the current time.
Date	getCreatedAt() Get the creation date of the property.
int	getDataType() Returns the data type of the stored Values.
String	getDefinition() Getter for the definition of the property.
String	getId() Get id of the property.
String	getMapping() Retrieve Getter for the mapping information stored in this Property.
String	getName() Getter for the name of the property.
String	getUnit() Returns the unit for all stored values.
Date	getUpdatedAt() Get the date of the last update.
long	getValueCount() Get the number of values of the property.
List<Value>	getValues() Get all values of the property.
boolean	isNone() Check if entity is null
void	setCreatedAt() Sets the creation time to the current time if the field is not set.
void	setDefinition(String definition) Setter for the definition of the property.
void	setMapping(String mapping) Set the mapping information for this Property.
void	setUnit(String unit) Set the unit for all stored values.
void	setUpdatedAt() Sets the time of the last update to the current time if the field is not set.
void	setValues(List<Value> values) Set the values of the property.
String	toString()

Methods inherited from class org.g_node.nix.base.Entity

equals, hashCode

Methods inherited from class org.g_node.nix.base.ImplContainer

isInitialized

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, capacity, capacity, deallocate, deallocate, deallocateReferences, fill, isNull, limit, limit, memchr, memcmp, memcpy, memmove, memset, offsetof, position, position, put, setNull, sizeof, zero

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Property

public Property()

Constructor that creates an uninitialized Property.

Calling any method on an uninitialized property will throw a RuntimeException.

Method Detail

isNone

@Cast(value="bool")
public boolean isNone()

Description copied from class: ImplContainer

Check if entity is null

Specified by:

isNone in class ImplContainer

Returns:

true if initialized else false

getId

@Name(value="id")
 @StdString
public String getId()

Get id of the property.

Specified by:

getId in class Entity

Returns:

ID string

getCreatedAt

public Date getCreatedAt()

Get the creation date of the property.

Specified by:

getCreatedAt in class Entity

Returns:

The creation date of the property.

getUpdatedAt

public Date getUpdatedAt()

Get the date of the last update.

Specified by:

getUpdatedAt in class Entity

Returns:

The date of the last update.

setUpdatedAt

public void setUpdatedAt()

Sets the time of the last update to the current time if the field is not set.

Specified by:

setUpdatedAt in class Entity

forceUpdatedAt

public void forceUpdatedAt()

Sets the time of the last update to the current time.

Specified by:

forceUpdatedAt in class Entity

setCreatedAt

public void setCreatedAt()

Sets the creation time to the current time if the field is not set.

Specified by:

setCreatedAt in class Entity

forceCreatedAt

public void forceCreatedAt(Date date)

Sets the creation date to the provided value even if the attribute is set.

Specified by:

forceCreatedAt in class Entity

Parameters:

date - The creation date to set.

getName

@Name(value="name")
 @StdString
public String getName()

Getter for the name of the property.

The of an property serves as a human readable identifier. It is not obliged to be unique. However it is strongly recommended to use unique name inside one specific Section.

Returns:

string The name of the property.

setDefinition

public void setDefinition(String definition)

Setter for the definition of the property.

Parameters:

definition - definition of property. If null is passed definition is removed.

getDefinition

public String getDefinition()

Getter for the definition of the property.

The definition is an optional property that allows the user to add a freely assignable textual definition to the property.

Returns:

The definition of the property. Returns null if not present.

getMapping

public String getMapping()

Retrieve Getter for the mapping information stored in this Property.

Returns:

The mapping for the Property. Returns null if not present.

setMapping

public void setMapping(String mapping)

Set the mapping information for this Property.

The mapping defines how this Property should be treated in a mapping procedure. The mapping is provided in form of an url pointing to the definition of a section into which this property should be mapped.

Parameters:

mapping - The mapping information. If null is passed the unit is removed.

getDataType

@Name(value="dataType")
 @ByVal
 @Cast(value="nix::DataType")
public int getDataType()

Returns the data type of the stored Values.

Returns:

The data type.

See Also:

DataType

getUnit

public String getUnit()

Returns the unit for all stored values.

Returns:

The unit for all values. Returns null if not present.

setUnit

public void setUnit(String unit)

Set the unit for all stored values.

Parameters:

unit - The unit for all values. If null is passed the unit is removed.

deleteValues

public void deleteValues()

Deletes all values from the property.

See Also:

Value

getValueCount

@Name(value="valueCount")
public long getValueCount()

Get the number of values of the property.

Returns:

The number of values.

See Also:

Value

setValues

public void setValues(List<Value> values)

Set the values of the property.

Parameters:

values - The values to set.

See Also:

Value

getValues

public List<Value> getValues()

Get all values of the property.

Returns:

The values of the property.

See Also:

Value

compareTo

public int compareTo(Property property)

Specified by:

compareTo in interface Comparable<Property>

toString

public String toString()

Overrides:

toString in class org.bytedeco.javacpp.Pointer