org.g_node.nix

Class Feature

java.lang.Object

org.bytedeco.javacpp.Pointer

org.g_node.nix.base.ImplContainer

org.g_node.nix.base.Entity

org.g_node.nix.Feature

@Platform(include="<nix/Feature.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 Feature
extends Entity

Feature

Feature entities are used to attach further data to a Tag or MultiTag

A Feature entity contains a link to an existing DataArray containing additional data that belongs to the respective tag. The way how data and feature are connected is specified by the link type.

Tagged

This link type indicates, that only a certain subset of the linked DataArray belongs to the Feature. This subset is defined by the position and extent of the respective tag.

Untagged

This implies that the whole data stored in the linked DataArray belongs to the Feature.

Indexed

This value is only valid for multi tags where it indicates that the data linked via this Feature has to be accessed according to the index in the respective position entry.

See Also:

DataArray, MultiTag, Tag

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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 feature.
DataArray	getData() Gets the data array associated with this feature.
String	getId() Get id of the feature.
int	getLinkType() Getter for the link type.
Date	getUpdatedAt() Get the date of the last update.
boolean	isNone() Check if entity is null
static String	linkTypeToString(int linkType) Convert LinkType to string.
void	setCreatedAt() Sets the creation time to the current time if the field is not set.
void	setData(DataArray data) Sets the data array associated with this feature.
void	setData(String nameOrId) Sets the data array associated with this feature.
void	setLinkType(int type) Setter for the link type.
void	setUpdatedAt() Sets the time of the last update to the current time if the field is not set.
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

Feature

public Feature()

Constructor that creates an uninitialized Feature.

Calling any method on an uninitialized feature 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 feature.

Specified by:

getId in class Entity

Returns:

ID string.

getCreatedAt

public Date getCreatedAt()

Get the creation date of the feature.

Specified by:

getCreatedAt in class Entity

Returns:

The creation date of the feature.

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.

setLinkType

@Name(value="linkType")
public void setLinkType(@Cast(value="nix::LinkType")
                                                int type)

Setter for the link type.

Parameters:

type - The link type to set.

See Also:

LinkType

getLinkType

@Name(value="linkType")
 @ByVal
 @Cast(value="nix::LinkType")
public int getLinkType()

Getter for the link type.

Returns:

The current link type of the feature.

See Also:

LinkType

setData

@Name(value="data")
public void setData(@StdString
                                        String nameOrId)

Sets the data array associated with this feature.

Parameters:

nameOrId - Name or id of the data array to set.

setData

@Name(value="data")
public void setData(@Const @ByRef
                                        DataArray data)

Sets the data array associated with this feature.

Parameters:

data - The data array to set.

See Also:

DataArray

getData

@Name(value="data")
 @ByVal
public DataArray getData()

Gets the data array associated with this feature.

Returns:

The associated data array.

See Also:

DataArray

linkTypeToString

public static String linkTypeToString(int linkType)

Convert LinkType to string.

Parameters:

linkType - link to convert

Returns:

link type as a string

See Also:

LinkType

toString

public String toString()

Overrides:

toString in class org.bytedeco.javacpp.Pointer