org.g_node.nix

Class Tag

java.lang.Object

org.bytedeco.javacpp.Pointer

org.g_node.nix.base.ImplContainer

org.g_node.nix.base.Entity

org.g_node.nix.base.NamedEntity

org.g_node.nix.base.EntityWithMetadata

org.g_node.nix.base.EntityWithSources

org.g_node.nix.Tag

All Implemented Interfaces:

Comparable

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

Tag

A tag class that defines a single point or region of interest.

Besides the DataArray the tag entities can be considered as the other core entities of the data model. They are meant to attach annotations directly to the data and to establish meaningful links between different kinds of stored data. Most importantly tags allow the definition of points or regions of interest in data that is stored in other DataArray entities. The data array entities the tag applies to are defined by its property getReferences(Predicate).

Further the referenced data is defined by an origin vector called getPosition() and an optional getExtent() vector that defines its size. Therefore position and extent of a tag, together with the references field defines a group of points or regions of interest collected from a subset of all available DataArray entities.

Further tags have a field called getFeatures() which makes it possible to associate other data with the tag. Semantically a feature of a tag is some additional data that contains additional information about the points of hyperslabs defined by the tag. This could be for example data that represents a stimulus (e.g. an image or a signal) that was applied in a certain interval during the recording.

See Also:

DataArray, Feature, MultiTag

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addReference(DataArray reference) Add a DataArray to the list of referenced data of the tag.
void	addReference(String id) Add a DataArray to the list of referenced data of the tag.
void	addSource(Source source) Associate a new source with the entity.
void	addSource(String id) Associate a new source with the entity.
Feature	createFeature(DataArray data, int linkType) Create a new feature.
Feature	createFeature(String dataArrayId, int linkType) Create a new feature.
boolean	deleteFeature(Feature feature) Deletes a feature from the tag.
boolean	deleteFeature(String id) Deletes a feature from the tag.
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 tag.
String	getDefinition() Getter for the definition of the tag.
double[]	getExtent() Gets the extent of a tag.
Feature	getFeature(long index) Retrieves a specific feature from the tag.
Feature	getFeature(String id) Retrieves a specific feature from the tag.
long	getFeatureCount() Gets the number of features in this block.
List<Feature>	getFeatures() Get all Features of this tag.
List<Feature>	getFeatures(java.util.function.Predicate<Feature> filter) Get all Features of this tag.
String	getId() Get id of the tag.
Section	getMetadata() Get metadata associated with this entity.
String	getName() Getter for the name of the tag.
double[]	getPosition() Gets the position of a tag.
DataArray	getReference(long index) Gets a referenced DataArray by its index.
DataArray	getReference(String id) Gets a specific referenced DataArray from the tag.
long	getReferenceCount() Gets the number of referenced DataArray entities of the tag.
List<DataArray>	getReferences() Get all referenced data arrays associated with this tag.
List<DataArray>	getReferences(java.util.function.Predicate<DataArray> filter) Get referenced data arrays associated with this tag.
Source	getSource(long index) Retrieves an associated source identified by its index.
Source	getSource(String id) Returns an associated source identified by its id.
long	getSourceCount() Get the number of sources associated with this entity.
List<Source>	getSources() Get all sources associated with this entity.
String	getType() Getter for the type of the tag.
List<String>	getUnits() Gets the units of the tag.
Date	getUpdatedAt() Get the date of the last update.
boolean	hasFeature(Feature feature) Checks if a specific feature exists on the tag.
boolean	hasFeature(String id) Checks if a specific feature exists on the tag.
boolean	hasReference(DataArray reference) Checks whether a DataArray is referenced by the tag.
boolean	hasReference(String id) Checks whether a DataArray is referenced by the tag.
boolean	hasSource(Source source) Checks if a specific source is associated with this entity.
boolean	hasSource(String id) Checks if a specific source is associated with this entity.
boolean	isNone() Check if entity is null
void	removeMetadata() Removes metadata associated with the entity.
boolean	removeReference(DataArray reference) Remove a DataArray from the list of referenced data of the tag.
boolean	removeReference(String id) Remove a DataArray from the list of referenced data of the tag.
boolean	removeSource(Source source) Remove a source from the list of associated sources.
boolean	removeSource(String id) Remove a source from the list of associated sources.
DataView	retrieveData(long referenceIndex) Returns the data associated with a certain reference.
DataView	retrieveFeatureData(long featureIndex) Returns the data stored in the selected Feature.
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 tag.
void	setExtent(double[] extent) Sets the extent of a tag.
void	setMetadata(Section metadata) Associate the entity with some metadata.
void	setMetadata(String id) Associate the entity with some metadata.
void	setPosition(double[] position) Sets the position of a tag.
void	setReferences(List<DataArray> references) Sets all referenced DataArray entities.
void	setSources(List<Source> sources) Set all sources associations for this entity.
void	setType(String type) Setter for the type of the tag.
void	setUnits(List<String> units) Sets the units of a tag.
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.NamedEntity

compareTo

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

Tag

public Tag()

Constructor that creates an uninitialized Tag.

Calling any method on an uninitialized Tag will throw a RuntimeException exception.

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 tag.

Specified by:

getId in class Entity

Returns:

ID string.

getCreatedAt

public Date getCreatedAt()

Get the creation date of the tag.

Specified by:

getCreatedAt in class Entity

Returns:

The creation date of the tag.

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.

setType

@Name(value="type")
public void setType(@StdString
                                        String type)

Setter for the type of the tag.

Specified by:

setType in class NamedEntity

Parameters:

type - The type of the tag.

getType

@Name(value="type")
 @StdString
public String getType()

Getter for the type of the tag.

Specified by:

getType in class NamedEntity

Returns:

The type of the tag.

getName

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

Getter for the name of the tag.

Specified by:

getName in class NamedEntity

Returns:

The name of the tag.

setDefinition

public void setDefinition(String definition)

Setter for the definition of the tag. If null is passed definition is removed.

Specified by:

setDefinition in class NamedEntity

Parameters:

definition - definition of tag.

getDefinition

public String getDefinition()

Getter for the definition of the tag.

Specified by:

getDefinition in class NamedEntity

Returns:

The definition of the tag.

getMetadata

@Name(value="metadata")
public Section getMetadata()

Get metadata associated with this entity.

Specified by:

getMetadata in class EntityWithMetadata

Returns:

The associated section, if no such section exists null is returned.

See Also:

Section

setMetadata

@Name(value="metadata")
public void setMetadata(@Const @ByRef
                                                Section metadata)

Associate the entity with some metadata.

Calling this method will replace previously stored information.

Specified by:

setMetadata in class EntityWithMetadata

Parameters:

metadata - The Section that should be associated with this entity.

See Also:

Section

setMetadata

@Name(value="metadata")
public void setMetadata(@StdString
                                                String id)

Associate the entity with some metadata.

Calling this method will replace previously stored information.

Specified by:

setMetadata in class EntityWithMetadata

Parameters:

id - The id of the Section that should be associated with this entity.

See Also:

Section

removeMetadata

public void removeMetadata()

Removes metadata associated with the entity.

Specified by:

removeMetadata in class EntityWithMetadata

See Also:

Section

getSourceCount

@Name(value="sourceCount")
public long getSourceCount()

Get the number of sources associated with this entity.

Specified by:

getSourceCount in class EntityWithSources

Returns:

The number sources.

See Also:

Source

hasSource

@Cast(value="bool")
public boolean hasSource(@StdString
                                             String id)

Checks if a specific source is associated with this entity.

Specified by:

hasSource in class EntityWithSources

Parameters:

id - The source id to check.

Returns:

True if the source is associated with this entity, false otherwise.

See Also:

Source

hasSource

@Cast(value="bool")
public boolean hasSource(@Const @ByRef
                                             Source source)

Checks if a specific source is associated with this entity.

Specified by:

hasSource in class EntityWithSources

Parameters:

source - The source to check.

Returns:

True if the source is associated with this entity, false otherwise.

See Also:

Source

getSource

public Source getSource(String id)

Returns an associated source identified by its id.

Specified by:

getSource in class EntityWithSources

Parameters:

id - The id of the associated source.

See Also:

Source

getSource

public Source getSource(long index)

Retrieves an associated source identified by its index.

Specified by:

getSource in class EntityWithSources

Parameters:

index - The index of the associated source.

Returns:

The source with the given id. If it doesn't exist an exception will be thrown.

See Also:

Source

getSources

public List<Source> getSources()

Get all sources associated with this entity.

Specified by:

getSources in class EntityWithSources

Returns:

All associated sources that match the given filter as a vector.

See Also:

Source

setSources

public void setSources(List<Source> sources)

Set all sources associations for this entity.

All previously existing associations will be overwritten.

Specified by:

setSources in class EntityWithSources

Parameters:

sources - A vector with all sources.

See Also:

Source

addSource

public void addSource(@StdString
                      String id)

Associate a new source with the entity.

If a source with the given id already is associated with the entity, the call will have no effect.

Specified by:

addSource in class EntityWithSources

Parameters:

id - The id of the source.

See Also:

Source

addSource

public void addSource(@Const @ByRef
                      Source source)

Associate a new source with the entity.

Calling this method will have no effect if the source is already associated to this entity.

Specified by:

addSource in class EntityWithSources

Parameters:

source - The source to add.

See Also:

Source

removeSource

@Cast(value="bool")
public boolean removeSource(@StdString
                                                String id)

Remove a source from the list of associated sources.

This method just removes the association between the entity and the source. The source itself will not be deleted from the file.

Specified by:

removeSource in class EntityWithSources

Parameters:

id - The id of the source to remove.

Returns:

True if the source was removed, false otherwise.

See Also:

Source

removeSource

@Cast(value="bool")
public boolean removeSource(@Const @ByRef
                                                Source source)

Remove a source from the list of associated sources.

This method just removes the association between the entity and the source. The source itself will not be deleted from the file.

Specified by:

removeSource in class EntityWithSources

Parameters:

source - The source to remove.

Returns:

True if the source was removed, false otherwise.

See Also:

Source

getUnits

public List<String> getUnits()

Gets the units of the tag.

The units are applied to all values for position and extent in order to calculate the right position vectors in referenced data arrays.

Returns:

All units of the tag as a list.

setUnits

public void setUnits(List<String> units)

Sets the units of a tag.

Parameters:

units - All units as a list. If null removes the units.

getPosition

public double[] getPosition()

Gets the position of a tag.

The position is a vector that points into referenced DataArrays.

Returns:

The position array.

setPosition

@Name(value="position")
public void setPosition(@StdVector
                                                double[] position)

Sets the position of a tag.

Parameters:

position - The position vector list.

getExtent

public double[] getExtent()

Gets the extent of a tag.

Given a specified position vector, the extent vector defined the size of a region of interest in the referenced DataArray entities.

Returns:

The extent of the tag.

setExtent

public void setExtent(double[] extent)

Sets the extent of a tag.

Parameters:

extent - The extent vector list.

hasReference

@Cast(value="bool")
public boolean hasReference(@StdString
                                                String id)

Checks whether a DataArray is referenced by the tag.

Parameters:

id - The id of the DataArray to check.

Returns:

True if the data array is referenced, false otherwise.

See Also:

DataArray

hasReference

@Cast(value="bool")
public boolean hasReference(@Const @ByRef
                                                DataArray reference)

Checks whether a DataArray is referenced by the tag.

Parameters:

reference - The DataArray to check.

Returns:

True if the data array is referenced, false otherwise.

See Also:

DataArray

getReferenceCount

@Name(value="referenceCount")
public long getReferenceCount()

Gets the number of referenced DataArray entities of the tag.

Returns:

The number of referenced data arrays.

See Also:

DataArray

getReference

public DataArray getReference(String id)

Gets a specific referenced DataArray from the tag.

Parameters:

id - The id of the referenced DataArray.

Returns:

The referenced data array.

See Also:

DataArray

getReference

public DataArray getReference(long index)

Gets a referenced DataArray by its index.

Parameters:

index - The index of the DataArray.

Returns:

The referenced data array.

See Also:

DataArray

addReference

public void addReference(@Const @ByRef
                         DataArray reference)

Add a DataArray to the list of referenced data of the tag.

Parameters:

reference - The DataArray to add.

See Also:

DataArray

addReference

public void addReference(@StdString
                         String id)

Add a DataArray to the list of referenced data of the tag.

Parameters:

id - The id of the DataArray to add.

See Also:

DataArray

removeReference

@Cast(value="bool")
public boolean removeReference(@Const @ByRef
                                                   DataArray reference)

Remove a DataArray from the list of referenced data of the tag.

This method just removes the association between the data array and the tag, the data array itself will not be removed from the file.

Parameters:

reference - The DataArray to remove.

Returns:

True if the DataArray was removed, false otherwise.

See Also:

DataArray

removeReference

@Cast(value="bool")
public boolean removeReference(@StdString
                                                   String id)

Remove a DataArray from the list of referenced data of the tag.

This method just removes the association between the data array and the tag, the data array itself will not be removed from the file.

Parameters:

id - The id of the DataArray to remove.

Returns:

True if the DataArray was removed, false otherwise.

See Also:

DataArray

getReferences

public List<DataArray> getReferences()

Get all referenced data arrays associated with this tag.

Always uses filter that accepts all sources.

Returns:

The filtered dimensions as a vector.

See Also:

DataArray

getReferences

public List<DataArray> getReferences(java.util.function.Predicate<DataArray> filter)

Get referenced data arrays associated with this tag.

The parameter filter can be used to filter data arrays by various criteria.

Parameters:

filter - A filter function.

Returns:

A list containing the matching data arrays.

See Also:

DataArray

setReferences

public void setReferences(List<DataArray> references)

Sets all referenced DataArray entities.

Previously referenced data arrays, that are not in the references vector will be removed.

Parameters:

references - All referenced arrays.

See Also:

DataArray

hasFeature

@Cast(value="bool")
public boolean hasFeature(@StdString
                                              String id)

Checks if a specific feature exists on the tag.

Parameters:

id - The id of a feature.

Returns:

True if the feature exists, false otherwise.

See Also:

Feature

hasFeature

@Cast(value="bool")
public boolean hasFeature(@Const @ByRef
                                              Feature feature)

Checks if a specific feature exists on the tag.

Parameters:

feature - The Feature to check.

Returns:

True if the feature exists, false otherwise.

See Also:

Feature

getFeatureCount

@Name(value="featureCount")
public long getFeatureCount()

Gets the number of features in this block.

Returns:

The number of features.

See Also:

Feature

getFeature

public Feature getFeature(String id)

Retrieves a specific feature from the tag.

Parameters:

id - The id of the feature.

Returns:

The feature with the specified id. If it doesn't exist an exception will be thrown.

See Also:

Feature

getFeature

public Feature getFeature(long index)

Retrieves a specific feature from the tag.

Parameters:

index - The index of the feature.

Returns:

The feature with the specified index.

See Also:

Feature

getFeatures

public List<Feature> getFeatures()

Get all Features of this tag.

Returns:

A vector containing the matching features.

See Also:

Feature

getFeatures

public List<Feature> getFeatures(java.util.function.Predicate<Feature> filter)

Get all Features of this tag.

The parameter filter can be used to filter features by various criteria.

Parameters:

filter - A filter function.

Returns:

A list containing the matching features.

See Also:

Feature

createFeature

public Feature createFeature(DataArray data,
                             int linkType)

Create a new feature.

Parameters:

data - The data array of this feature.

linkType - The link type of this feature.

Returns:

The created feature object.

See Also:

Feature

createFeature

public Feature createFeature(String dataArrayId,
                             int linkType)

Create a new feature.

Parameters:

dataArrayId - The id of the data array of this feature.

linkType - The link type of this feature.

Returns:

The created feature object.

See Also:

Feature

deleteFeature

@Cast(value="bool")
public boolean deleteFeature(@StdString
                                                 String id)

Deletes a feature from the tag.

Parameters:

id - The id of the feature to remove.

Returns:

True if the feature was removed, false otherwise.

See Also:

Feature

deleteFeature

@Cast(value="bool")
public boolean deleteFeature(@Const @ByRef
                                                 Feature feature)

Deletes a feature from the tag.

Parameters:

feature - The feature to remove.

Returns:

True if the feature was removed, false otherwise.

See Also:

Feature

retrieveData

@ByVal
public DataView retrieveData(@Cast(value="size_t")
                                    long referenceIndex)

Returns the data associated with a certain reference.

Parameters:

referenceIndex - The index of the reference of which the data should be returned.

Returns:

the data

See Also:

DataView

retrieveFeatureData

@ByVal
public DataView retrieveFeatureData(@Cast(value="size_t")
                                           long featureIndex)

Returns the data stored in the selected Feature.

Parameters:

featureIndex - The index of the requested feature.

Returns:

The data stored in the Feature.

See Also:

DataView

toString

public String toString()

Overrides:

toString in class org.bytedeco.javacpp.Pointer