org.g_node.nix

Class MultiTag

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

All Implemented Interfaces:

Comparable

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

MultiTag

A tag class that can be used to tag multiple positions or regions in data.

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 setReferences(List).

Further the referenced data is defined by an origin vector called setPositions(DataArray) and an optional setExtents(DataArray) 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(Predicate) 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.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addReference(DataArray reference) Adds a new DataArray to the list of referenced data.
void	addReference(String nameOrId) Add a new DataArray to the list of referenced data.
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) Delete a feature from the tag.
boolean	deleteFeature(String nameOrId) Delete 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 multitag.
String	getDefinition() Getter for the definition of the multitag.
DataArray	getExtents() Getter for the extents of a tag.
Feature	getFeature(long index) Retrieves a specific feature from the tag.
Feature	getFeature(String nameOrId) Retrieves a specific feature from the tag.
long	getFeatureCount() Returns the number of features in this block.
List<Feature>	getFeatures() Get all Feature entities contained in the tag.
List<Feature>	getFeatures(java.util.function.Predicate<Feature> filter) Get all Features of this tag.
String	getId() Get id of the multitag
Section	getMetadata() Get metadata associated with this entity.
String	getName() Getter for the name of the multitag.
DataArray	getPositions() Getter for the positions of a tag.
DataArray	getReference(long index) Get a referenced DataArray by its index.
DataArray	getReference(String nameOrId) Get a referenced DataArray by its name or id.
long	getReferenceCount() Get the number of DataArray entities that are referenced by the tag.
List<DataArray>	getReferences() Get all referenced data arrays associated with the 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 multitag.
List<String>	getUnits() Gets for 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 nameOrId) Checks if a specific feature exists on the tag.
boolean	hasPositions() Determine whether this DataArray contains positions.
boolean	hasReference(DataArray reference) Checks if the specified DataArray is referenced by the tag.
boolean	hasReference(String nameOrId) Checks if the specified DataArray is referenced in this 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	removeExtents() Deleter for the reference to the extents DataArray.
void	removeMetadata() Removes metadata associated with the entity.
boolean	removeReference(DataArray reference) Remove a DataArray from the list of referenced data.
boolean	removeReference(String nameOrId) Remove a DataArray from the list of referenced data.
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 positionIndex, long referenceIndex) Retrieves the data slice tagged by a certain position and extent of a certain reference.
DataView	retrieveFeatureData(long positionIndex, long featureIndex) Retrieves the data stored in a feature related to a certain position of this tag.
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 multitag.
void	setExtents(DataArray extents) Sets the extents DataArray of the tag.
void	setExtents(String nameOrId) Setter for the positions of the tag.
void	setMetadata(Section metadata) Associate the entity with some metadata.
void	setMetadata(String id) Associate the entity with some metadata.
void	setPositions(DataArray positions) Setter for the positions of the tag.
void	setPositions(String nameOrId) Setter for the positions of the tag.
void	setReferences(List<DataArray> references) Setter for all referenced DataArrays.
void	setSources(List<Source> sources) Set all sources associations for this entity.
void	setType(String type) Setter for the type of the multitag.
void	setUnits(List<String> units) Setter for 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

MultiTag

public MultiTag()

Constructor that creates an uninitialized MultiTag.

Calling any method on an uninitialized MultiTag 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 multitag

Specified by:

getId in class Entity

Returns:

id string

getCreatedAt

public Date getCreatedAt()

Get the creation date of the multitag.

Specified by:

getCreatedAt in class Entity

Returns:

The creation date of the multitag.

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

Specified by:

setType in class NamedEntity

Parameters:

type - The type of the multitag.

getType

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

Getter for the type of the multitag.

Specified by:

getType in class NamedEntity

Returns:

The type of the multitag.

getName

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

Getter for the name of the multitag.

Specified by:

getName in class NamedEntity

Returns:

The name of the multitag.

setDefinition

public void setDefinition(String definition)

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

Specified by:

setDefinition in class NamedEntity

Parameters:

definition - definition of multitag.

getDefinition

public String getDefinition()

Getter for the definition of the multitag.

Specified by:

getDefinition in class NamedEntity

Returns:

The definition of the multitag.

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

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 list 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

getPositions

public DataArray getPositions()

Getter for the positions of a tag.

The positions of a multi tag are defined in a DataArray. This array has to define a set of origin vectors, each defining a point inside the referenced data or the beginning of a region of interest.

Returns:

The DataArray defining the positions of the tag.

See Also:

DataArray

setPositions

@Name(value="positions")
public void setPositions(@StdString
                                                  String nameOrId)

Setter for the positions of the tag.

Parameters:

nameOrId - Name or id of the DataArray that defines the positions for this tag.

See Also:

DataArray

setPositions

@Name(value="positions")
public void setPositions(@Const @ByRef
                                                  DataArray positions)

Setter for the positions of the tag.

Parameters:

positions - The DataArray containing the positions of the tag.

See Also:

DataArray

hasPositions

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

Determine whether this DataArray contains positions.

Returns:

True if the DataArray has positions, false otherwise.

getExtents

public DataArray getExtents()

Getter for the extents of a tag.

The extents of a multi tag are defined in an associated DataArray. This array has to define a set of extent vectors, each defining the size of the corresponding region of interest.

Returns:

The DataArray defining the extents of the tag.

See Also:

DataArray

setExtents

@Name(value="extents")
public void setExtents(@Const @ByRef
                                              DataArray extents)

Sets the extents DataArray of the tag.

Parameters:

extents - The DataArray containing the extents of the tag.

See Also:

DataArray

setExtents

@Name(value="extents")
public void setExtents(@StdString
                                              String nameOrId)

Setter for the positions of the tag.

Parameters:

nameOrId - Name or id of the DataArray that defines the extents of the tag.

See Also:

DataArray

removeExtents

public void removeExtents()

Deleter for the reference to the extents DataArray.

This function only removes the association between the tag and the data array, but does not delete the data array itself.

See Also:

DataArray

getUnits

public List<String> getUnits()

Gets for 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)

Setter for the units of a tag.

All previously defined units will be replaced by the ones passed to the units parameter.

Parameters:

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

hasReference

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

Checks if the specified DataArray is referenced by the tag.

Parameters:

reference - The data array to check.

Returns:

True if the data array is referenced, false otherwise.

See Also:

DataArray

hasReference

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

Checks if the specified DataArray is referenced in this tag.

Parameters:

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

Returns:

True if a data array with the given id is referenced, false otherwise.

See Also:

DataArray

getReferenceCount

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

Get the number of DataArray entities that are referenced by the tag.

Returns:

The number of referenced data arrays.

See Also:

DataArray

getReference

public DataArray getReference(String nameOrId)

Get a referenced DataArray by its name or id.

Parameters:

nameOrId - Name or id of the data array.

Returns:

The referenced data array.

See Also:

DataArray

getReference

public DataArray getReference(long index)

Get a referenced DataArray by its index.

Parameters:

index - The index of the data array.

Returns:

The referenced data array.

See Also:

DataArray

addReference

public void addReference(@StdString
                         String nameOrId)

Add a new DataArray to the list of referenced data.

Parameters:

nameOrId - Name or id of the data array.

See Also:

DataArray

addReference

public void addReference(@Const @ByRef
                         DataArray reference)

Adds a new DataArray to the list of referenced data.

Parameters:

reference - The DataArray that should be referenced.

See Also:

DataArray

removeReference

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

Remove a DataArray from the list of referenced data.

This function only removes the association between the tag and the data array, but does not delete the data array itself.

Parameters:

nameOrId - Name or id of the data array.

Returns:

True if the data array was removed, false otherwise.

See Also:

DataArray

removeReference

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

Remove a DataArray from the list of referenced data.

This function only removes the association between the tag and the data array, but does not delete the data array itself.

Parameters:

reference - The DataArray to remove.

Returns:

True if the data array was removed, false otherwise.

See Also:

DataArray

getReferences

public List<DataArray> getReferences()

Get all referenced data arrays associated with the tag.

Always uses filter that accepts all sources.

Returns:

A list containing all filtered DataArray entities.

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)

Setter for all referenced DataArrays.

Previously referenced data will be replaced. removed.

Parameters:

references - All referenced arrays.

See Also:

DataArray

retrieveData

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

Retrieves the data slice tagged by a certain position and extent of a certain reference.

Parameters:

positionIndex - the index of the requested position.

referenceIndex - the index of the requested reference.

Returns:

the requested data.

See Also:

DataView

hasFeature

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

Checks if a specific feature exists on the tag.

Parameters:

nameOrId - Name or 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()

Returns the number of features in this block.

Returns:

The number of features.

See Also:

Feature

getFeature

public Feature getFeature(String nameOrId)

Retrieves a specific feature from the tag.

Parameters:

nameOrId - Name or id of the feature.

Returns:

The feature with the specified name or 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 Feature entities contained in the tag.

Returns:

A list containing all filtered Feature entities.

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 - Data array

linkType - The link type of this feature.

Returns:

The created feature object. Returns null on error.

See Also:

Feature

createFeature

public Feature createFeature(String dataArrayId,
                             int linkType)

Create a new feature.

Parameters:

dataArrayId - The data array that is part of the new feature.

linkType - The link type of this feature.

Returns:

The created feature object. Returns null on error.

See Also:

Feature

deleteFeature

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

Delete a feature from the tag.

Parameters:

nameOrId - Name or 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)

Delete a feature from the tag.

Parameters:

feature - The feature to remove.

Returns:

True if the feature was removed, false otherwise.

See Also:

Feature

retrieveFeatureData

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

Retrieves the data stored in a feature related to a certain position of this tag.

Parameters:

positionIndex - The index of the requested position

featureIndex - The index of the selected feature

Returns:

The data

See Also:

DataView

toString

public String toString()

Overrides:

toString in class org.bytedeco.javacpp.Pointer