org.g_node.nix

Class Group

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

All Implemented Interfaces:

Comparable

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

An additional grouping element within Block.

Constructor Summary

Constructors

Constructor and Description
Group()

Method Summary

Modifier and Type	Method and Description
void	addDataArray(DataArray dataArray) Add a DataArray to the list of referenced data of the group.
void	addDataArray(String nameOrId) Add a DataArray to the list of referenced data of the group.
void	addMultiTag(MultiTag tag) Add a MultiTag to the list of referenced tags of the group.
void	addMultiTag(String nameOrId) Add a MultiTag to the list of referenced tags of the group.
void	addSource(Source source) Associate a new source with the entity.
void	addSource(String id) Associate a new source with the entity.
void	addTag(String nameOrId) Add a Tag to the list of referenced tags of the group.
void	addTag(Tag tag) Add a Tag to the list of referenced tags of the group.
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 group.
DataArray	getDataArray(long index) Retrieves a data array by index.
DataArray	getDataArray(String nameOrId) Retrieves a specific data array from the group by name or id.
long	getDataArrayCount() Returns the number of all data arrays of the block.
List<DataArray>	getDataArrays() Get data arrays within this group.
List<DataArray>	getDataArrays(java.util.function.Predicate<DataArray> filter) Get data arrays within this group.
String	getDefinition() Getter for the definition of the group.
String	getId() Get id of the group.
Section	getMetadata() Get metadata associated with this entity.
MultiTag	getMultiTag(long index) Retrieves a specific tag by index.
MultiTag	getMultiTag(String nameOrId) Retrieves a specific tag from the group by its id.
long	getMultiTagCount() Returns the number of tags within this group.
List<MultiTag>	getMultiTags() Gets all MultiTags within this group.
List<MultiTag>	getMultiTags(java.util.function.Predicate<MultiTag> filter) Get tags within this block.
String	getName() Getter for the name of the group.
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.
List<Source>	getSources(java.util.function.Predicate<Source> filter) Get all sources associated with this entity.
Tag	getTag(long index) Retrieves a specific tag by index.
Tag	getTag(String nameOrId) Retrieves a specific tag from the group by its id.
long	getTagCount() Returns the number of tags within this group.
List<Tag>	getTags() Gets all Tags within this group.
List<Tag>	getTags(java.util.function.Predicate<Tag> filter) Get tags within this block.
String	getType() Getter for the type of the group.
Date	getUpdatedAt() Get the date of the last update.
boolean	hasDataArray(DataArray dataArray) Checks if a specific data array exists in this group.
boolean	hasDataArray(String nameOrId) Checks if a specific data array exists in this group.
boolean	hasMultiTag(MultiTag tag) Checks if a specific tag exists in the group.
boolean	hasMultiTag(String nameOrId) Checks if a specific tag exists in the group.
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	hasTag(String nameOrId) Checks if a specific tag exists in the group.
boolean	hasTag(Tag tag) Checks if a specific tag exists in the group.
boolean	isNone() Check if entity is null
boolean	removeDataArray(DataArray dataArray) Remove a DataArray from the list of referenced data of the group.
boolean	removeDataArray(String nameOrId) Remove a DataArray from the list of referenced data of the group.
void	removeMetadata() Removes metadata associated with the entity.
boolean	removeMultiTag(MultiTag tag) Remove a MultiTag from the list of referenced data of the group.
boolean	removeMultiTag(String nameOrId) Remove a MultiTag from the list of referenced tags of the group.
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.
boolean	removeTag(String nameOrId) Remove a Tag from the list of referenced tags of the group.
boolean	removeTag(Tag tag) Remove a Tag from the list of referenced data of the group.
void	setCreatedAt() Sets the creation time to the current time if the field is not set.
void	setDataArrays(List<DataArray> dataArrays) Set all DataArray associations for this group.
void	setDefinition(String definition) Setter for the definition of the group.
void	setMetadata(Section metadata) Associate the entity with some metadata.
void	setMetadata(String id) Associate the entity with some metadata.
void	setMultiTags(List<MultiTag> tags) Set all MultiTag associations for this group.
void	setSources(List<Source> sources) Set all sources associations for this entity.
void	setTags(List<Tag> tags) Set all Tag associations for this group.
void	setType(String type) Setter for the type of the group.
void	setUpdatedAt() Sets the time of the last update to the current time if the field is not set.

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, toString, zero

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Group

public Group()

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

Specified by:

getId in class Entity

Returns:

The ID string.

getCreatedAt

public Date getCreatedAt()

Get the creation date of the group.

Specified by:

getCreatedAt in class Entity

Returns:

The creation date of the group.

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

Specified by:

setType in class NamedEntity

Parameters:

type - The type of the group.

getType

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

Getter for the type of the group.

Specified by:

getType in class NamedEntity

Returns:

The type of the group.

getName

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

Getter for the name of the group.

Specified by:

getName in class NamedEntity

Returns:

The name of the group.

setDefinition

public void setDefinition(String definition)

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

Specified by:

setDefinition in class NamedEntity

Parameters:

definition - definition of the group.

getDefinition

public String getDefinition()

Getter for the definition of the group.

Specified by:

getDefinition in class NamedEntity

Returns:

The definition of the group.

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 an existing association.

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 an existing association.

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

getSources

public List<Source> getSources(java.util.function.Predicate<Source> filter)

Get all sources associated with this entity.

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

hasDataArray

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

Checks if a specific data array exists in this group.

Parameters:

nameOrId - Name or id of a data array.

Returns:

True if the data array exists, false otherwise.

See Also:

DataArray

getDataArrayCount

@Name(value="dataArrayCount")
public long getDataArrayCount()

Returns the number of all data arrays of the block.

Returns:

The number of data arrays of the block.

See Also:

DataArray

hasDataArray

@Cast(value="bool")
public boolean hasDataArray(@Const @ByRef
                                                DataArray dataArray)

Checks if a specific data array exists in this group.

Parameters:

dataArray - The data array to check.

Returns:

True if the data array exists, false otherwise.

See Also:

DataArray

getDataArray

public DataArray getDataArray(String nameOrId)

Retrieves a specific data array from the group by name or id.

Parameters:

nameOrId - Name or id of an existing data array.

Returns:

The data array with the specified id. If this doesn't exist, an exception will be thrown.

See Also:

DataArray

getDataArray

public DataArray getDataArray(long index)

Retrieves a data array by index.

Parameters:

index - The index of the data array.

Returns:

The data array at the specified index.

See Also:

DataArray

getDataArrays

public List<DataArray> getDataArrays()

Get data arrays within this group.

Returns:

A list of data arrays

See Also:

DataArray

getDataArrays

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

Get data arrays within this group. The parameter filter can be used to filter data arrays by various criteria.

Parameters:

filter - A filter function.

Returns:

A list that contains all filtered data arrays.

See Also:

DataArray

setDataArrays

public void setDataArrays(List<DataArray> dataArrays)

Set all DataArray associations for this group. All previously existing associations will be overwritten.

Parameters:

dataArrays - A list with all DataArray entities to add.

See Also:

DataArray

addDataArray

public void addDataArray(@StdString
                         String nameOrId)

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

Parameters:

nameOrId - The id of the DataArray to add.

addDataArray

public void addDataArray(@Const @ByRef
                         DataArray dataArray)

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

Parameters:

dataArray - The DataArray to add.

removeDataArray

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

Remove a DataArray from the list of referenced data of the group. This method just removes the association between the data array and the group, the data array itself will not be removed from the file.

Parameters:

nameOrId - The id of the DataArray to remove.

Returns:

True if the DataArray was removed, false otherwise.

removeDataArray

@Cast(value="bool")
public boolean removeDataArray(@Const @ByRef
                                                   DataArray dataArray)

Remove a DataArray from the list of referenced data of the group. This method just removes the association between the data array and the group, the data array itself will not be removed from the file.

Parameters:

dataArray - The DataArray to remove.

Returns:

True if the DataArray was removed, false otherwise.

hasTag

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

Checks if a specific tag exists in the group.

Parameters:

nameOrId - Name or id of a tag to check.

Returns:

True if the tag exists, false otherwise.

See Also:

Tag

hasTag

@Cast(value="bool")
public boolean hasTag(@Const @ByRef
                                          Tag tag)

Checks if a specific tag exists in the group.

Parameters:

tag - The tag to check.

Returns:

True if the tag exists, false otherwise.

See Also:

Tag

getTagCount

@Name(value="tagCount")
public long getTagCount()

Returns the number of tags within this group.

Returns:

The number of tags.

getTag

public Tag getTag(String nameOrId)

Retrieves a specific tag from the group by its id.

Parameters:

nameOrId - Name or id of the tag.

Returns:

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

See Also:

Tag

getTag

public Tag getTag(long index)

Retrieves a specific tag by index.

Parameters:

index - The index of the tag.

Returns:

The tag at the specified index.

See Also:

Tag

getTags

public List<Tag> getTags()

Gets all Tags within this group.

Returns:

list of all tags.

See Also:

Tag

getTags

public List<Tag> getTags(java.util.function.Predicate<Tag> filter)

Get tags within this block. The parameter filter can be used to filter tags by variouscriteria.

Parameters:

filter - A filter function.

Returns:

A list that contains all filtered tags.

See Also:

Tag

setTags

public void setTags(List<Tag> tags)

Set all Tag associations for this group. All previously existing associations will be overwritten.

Parameters:

tags - A list with all Tag entities to add.

See Also:

Tag

addTag

public void addTag(@StdString
                   String nameOrId)

Add a Tag to the list of referenced tags of the group.

Parameters:

nameOrId - The id of the Tag to add.

addTag

public void addTag(@Const @ByRef
                   Tag tag)

Add a Tag to the list of referenced tags of the group.

Parameters:

tag - The Tag to add.

removeTag

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

Remove a Tag from the list of referenced tags of the group. This method just removes the association between the tag and the group, the tag itself will not be removed from the file.

Parameters:

nameOrId - The id of the Tag to remove.

Returns:

True if the Tag was removed, false otherwise.

removeTag

@Cast(value="bool")
public boolean removeTag(@Const @ByRef
                                             Tag tag)

Remove a Tag from the list of referenced data of the group. This method just removes the association between the tag and the group, the tag itself will not be removed from the file.

Parameters:

tag - The Tag to remove.

Returns:

True if the Tag was removed, false otherwise.

hasMultiTag

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

Checks if a specific tag exists in the group.

Parameters:

nameOrId - Name or id of a tag to check.

Returns:

True if the tag exists, false otherwise.

See Also:

MultiTag

hasMultiTag

@Cast(value="bool")
public boolean hasMultiTag(@Const @ByRef
                                               MultiTag tag)

Checks if a specific tag exists in the group.

Parameters:

tag - The tag to check.

Returns:

True if the tag exists, false otherwise.

See Also:

MultiTag

getMultiTagCount

@Name(value="multiTagCount")
public long getMultiTagCount()

Returns the number of tags within this group.

Returns:

The number of tags.

getMultiTag

public MultiTag getMultiTag(String nameOrId)

Retrieves a specific tag from the group by its id.

Parameters:

nameOrId - Name or id of the tag.

Returns:

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

See Also:

MultiTag

getMultiTag

public MultiTag getMultiTag(long index)

Retrieves a specific tag by index.

Parameters:

index - The index of the tag.

Returns:

The tag at the specified index.

See Also:

MultiTag

getMultiTags

public List<MultiTag> getMultiTags()

Gets all MultiTags within this group.

Returns:

list of all tags.

See Also:

MultiTag

getMultiTags

public List<MultiTag> getMultiTags(java.util.function.Predicate<MultiTag> filter)

Get tags within this block. The parameter filter can be used to filter tags by variouscriteria.

Parameters:

filter - A filter function.

Returns:

A list that contains all filtered tags.

See Also:

MultiTag

setMultiTags

public void setMultiTags(List<MultiTag> tags)

Set all MultiTag associations for this group. All previously existing associations will be overwritten.

Parameters:

tags - A list with all MultiTag entities to add.

See Also:

MultiTag

addMultiTag

public void addMultiTag(@StdString
                        String nameOrId)

Add a MultiTag to the list of referenced tags of the group.

Parameters:

nameOrId - The id of the MultiTag to add.

addMultiTag

public void addMultiTag(@Const @ByRef
                        MultiTag tag)

Add a MultiTag to the list of referenced tags of the group.

Parameters:

tag - The MultiTag to add.

removeMultiTag

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

Remove a MultiTag from the list of referenced tags of the group. This method just removes the association between the tag and the group, the tag itself will not be removed from the file.

Parameters:

nameOrId - The id of the MultiTag to remove.

Returns:

True if the MultiTag was removed, false otherwise.

removeMultiTag

@Cast(value="bool")
public boolean removeMultiTag(@Const @ByRef
                                                  MultiTag tag)

Remove a MultiTag from the list of referenced data of the group. This method just removes the association between the tag and the group, the tag itself will not be removed from the file.

Parameters:

tag - The MultiTag to remove.

Returns:

True if the MultiTag was removed, false otherwise.