org.g_node.nix

Class Block

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

All Implemented Interfaces:

Comparable

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

Block

Class for grouping further data entities.

The Block entity is a top-level, summarizing element that allows to group the other data entities belonging for example to the same recording session. All data entities such as Source, DataArray, Tag and MultiTag have to be associated with one Block.

Create a new Block

A block can only be created on an existing file object. Do not use the blocks constructors for this purpose.

      File f = ...;
      Block b = f.createBlock("session one", "recording_session");
 

Working with blocks

After a block was created it can be used to create further entities. See the documentation of Source, DataArray, Tag and MultiTag for more information. The next example shows how some properties of a block can be accessed.

 
      File f = ...;
      Block b = f.createBlock("session one", "recording_session");

      // add metadata to a block
      Section s = f.getSection(sec_id);
      b.setMetadata(s); 

      // get associated metadata from a block
      Section s1 = b.getMetadata();

      // remove associated metadata from a block
      b.removeMetadata();
 

Deleting a block

When a block is deleted from a file all contained data e.g. sources, data arrays and tags will be removed too.

      File f = ...;
      boolean deleted = f.deleteBlock(some_id);
      System.out.println("The block was " + (deleted ? "" : "not ") + "deleted.");
 

See Also:

Source, DataArray, Tag, MultiTag

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
DataArray	createDataArray(String name, String type, int dataType, NDSize shape) Create a new data array associated with this block.
Group	createGroup(String name, String type) Create a new group associated with this block.
MultiTag	createMultiTag(String name, String type, DataArray positions) Create a new multi tag associated with this block.
Source	createSource(String name, String type) Create a new root source.
Tag	createTag(String name, String type, double[] position) Create a new tag associated with this block.
boolean	deleteDataArray(DataArray dataArray) Deletes a data array from this block.
boolean	deleteDataArray(String nameOrId) Deletes a data array from this block.
boolean	deleteGroup(Group group) Deletes a group from the block.
boolean	deleteGroup(String nameOrId) Deletes a Group from the block.
boolean	deleteMultiTag(MultiTag multiTag) Deletes a multi tag from the block.
boolean	deleteMultiTag(String nameOrId) Deletes a multi tag from the block.
boolean	deleteSource(Source source) Deletes a root source.
boolean	deleteSource(String nameOrId) Deletes a root source.
boolean	deleteTag(String nameOrId) Deletes a tag from the block.
boolean	deleteTag(Tag tag) Deletes a tag from the block.
List<Source>	findSources() Get all sources in this block recursively.
List<Source>	findSources(int maxDepth) Get all sources in this block recursively.
List<Source>	findSources(java.util.function.Predicate<Source> filter) Get all sources in this block recursively.
List<Source>	findSources(java.util.function.Predicate<Source> filter, int maxDepth) Get all sources in this block recursively.
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 block.
DataArray	getDataArray(long index) Retrieves a data array by index.
DataArray	getDataArray(String nameOrId) Retrieves a specific data array from the block by name or id.
long	getDataArrayCount() Returns the number of all data arrays of the block.
List<DataArray>	getDataArrays() Get data arrays within this block.
List<DataArray>	getDataArrays(java.util.function.Predicate<DataArray> filter) Get data arrays within this block.
String	getDefinition() Getter for the definition of the block.
Group	getGroup(long index) Retrieves a specific group by index.
Group	getGroup(String nameOrId) Retrieves a specific group from the block by its name or id.
long	getGroupCount() Returns the number of groups associated with this block.
List<Group>	getGroups() List all groups within this block.
List<Group>	getGroups(java.util.function.Predicate<Group> filter) List all groups within this block.
String	getId() Get id of the block
Section	getMetadata() Get metadata associated with this entity.
MultiTag	getMultiTag(long index) Retrieves a specific multi tag by index.
MultiTag	getMultiTag(String nameOrId) Retrieves a specific multi tag from the block by its id.
long	getMultiTagCount() Returns the number of multi tags associated with this block.
List<MultiTag>	getMultiTags() Get multi tags within this block.
List<MultiTag>	getMultiTags(java.util.function.Predicate<MultiTag> filter) Get multi tags within this block.
String	getName() Getter for the name of the block.
Source	getSource(long index) Retrieves a specific root source by index.
Source	getSource(String nameOrId) Retrieves a specific root source by its id.
long	getSourceCount() Returns the number of root sources in this block.
List<Source>	getSources() Get all root sources associated with this block.
List<Source>	getSources(java.util.function.Predicate<Source> filter) Get all root sources associated with this block.
Tag	getTag(long index) Retrieves a specific tag by index.
Tag	getTag(String nameOrId) Retrieves a specific tag from the block by its id.
long	getTagCount() Returns the number of tags within this block.
List<Tag>	getTags() Get tags within this block.
List<Tag>	getTags(java.util.function.Predicate<Tag> filter) Get tags within this block.
String	getType() Getter for the type of the block.
Date	getUpdatedAt() Get the date of the last update.
boolean	hasDataArray(DataArray dataArray) Checks if a specific data array exists in this block.
boolean	hasDataArray(String nameOrId) Checks if a specific data array exists in this block.
boolean	hasGroup(Group group) Checks if a specific group exists in the block.
boolean	hasGroup(String nameOrId) Checks if a specific group exists in the block.
boolean	hasMultiTag(MultiTag multiTag) Checks if a specific multi tag exists in the block.
boolean	hasMultiTag(String nameOrId) Checks if a specific multi tag exists in the block.
boolean	hasSource(Source source) Checks if this block has a specific root source.
boolean	hasSource(String nameOrId) Checks if this block has a specific root source.
boolean	hasTag(String nameOrId) Checks if a specific tag exists in the block.
boolean	hasTag(Tag tag) Checks if a specific tag exists in the block.
boolean	isNone() Check if entity is null
void	removeMetadata() Removes metadata associated with the entity.
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 block.
void	setMetadata(Section metadata) Associate the entity with some metadata.
void	setMetadata(String id) Associate the entity with some metadata.
void	setType(String type) Setter for the type of the block.
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

Block

public Block()

Constructor that creates an uninitialized Block.

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

Specified by:

getId in class Entity

Returns:

ID string.

getCreatedAt

public Date getCreatedAt()

Get the creation date of the block.

Specified by:

getCreatedAt in class Entity

Returns:

The creation date of the block.

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

Specified by:

setType in class NamedEntity

Parameters:

type - The type of the block.

getType

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

Getter for the type of the block.

Specified by:

getType in class NamedEntity

Returns:

The type of the block.

getName

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

Getter for the name of the block.

Specified by:

getName in class NamedEntity

Returns:

The name of the block.

setDefinition

public void setDefinition(String definition)

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

Specified by:

setDefinition in class NamedEntity

Parameters:

definition - The definition of block.

getDefinition

public String getDefinition()

Getter for the definition of the block.

Specified by:

getDefinition in class NamedEntity

Returns:

The definition of the block.

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

hasSource

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

Checks if this block has a specific root source.

Parameters:

nameOrId - Name or id of the source.

Returns:

True if a source with the given id exists at the root, false otherwise.

See Also:

Source

hasSource

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

Checks if this block has a specific root source.

Parameters:

source - The source to check.

Returns:

True if the source exists at the root, false otherwise.

See Also:

Source

getSource

public Source getSource(String nameOrId)

Retrieves a specific root source by its id.

Parameters:

nameOrId - Name or id of the source.

Returns:

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

See Also:

Source

getSource

public Source getSource(long index)

Retrieves a specific root source by index.

Parameters:

index - The index of the source.

Returns:

The source at the specified index.

See Also:

Source

getSourceCount

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

Returns the number of root sources in this block.

Returns:

The number of root sources.

See Also:

Source

getSources

public List<Source> getSources()

Get all root sources associated with this block.

Returns:

list of source.

See Also:

Source

getSources

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

Get all root sources associated with this block.

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

Parameters:

filter - A filter function.

Returns:

A list containing the matching root sources.

See Also:

Source

findSources

public List<Source> findSources(java.util.function.Predicate<Source> filter,
                                int maxDepth)

Get all sources in this block recursively.

This method traverses the tree of all sources in the block. The traversal is accomplished via breadth first and can be limited in depth. On each node or source a filter is applied. If the filter returns true the respective source will be added to the result list. By default a filter is used that accepts all sources.

Parameters:

filter - A filter function.

maxDepth - The maximum depth of traversal.

Returns:

A list containing the matching sources.

See Also:

Source

findSources

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

Get all sources in this block recursively.

This method traverses the tree of all sources in the block. The traversal is accomplished via breadth first and can be limited in depth. On each node or source a filter is applied. If the filter returns true the respective source will be added to the result list. By default a sources at all depths are considered.

Parameters:

filter - A filter function.

Returns:

A list containing the matching sources.

See Also:

Source

findSources

public List<Source> findSources(int maxDepth)

Get all sources in this block recursively.

This method traverses the tree of all sources in the block. The traversal is accomplished via breadth first and can be limited in depth. On each node or source a filter is applied. If the filter returns true the respective source will be added to the result list. By default a filter is used that accepts all sources.

Parameters:

maxDepth - The maximum depth of traversal.

Returns:

A list containing the matching sources.

See Also:

Source

findSources

public List<Source> findSources()

Get all sources in this block recursively.

This method traverses the tree of all sources in the block. The traversal is accomplished via breadth first and can be limited in depth. On each node or source a filter is applied. If the filter returns true the respective source will be added to the result list. By default a filter is used that accepts all sources at all depths.

Returns:

A list containing the matching sources.

See Also:

Source

createSource

public Source createSource(String name,
                           String type)

Create a new root source.

Parameters:

name - The name of the source to create.

type - The type of the source.

Returns:

The created source object.

See Also:

Source

deleteSource

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

Deletes a root source.

This will also delete all child sources of this root source from the file. The deletion of a source can't be undone.

Parameters:

nameOrId - Name or id of the source to delete.

Returns:

True if the source was deleted, false otherwise.

See Also:

Source

deleteSource

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

Deletes a root source.

This will also delete all child sources of this root source from the file. The deletion of a source can't be undone.

Parameters:

source - The source to delete.

Returns:

True if the source was deleted, false otherwise.

See Also:

Source

hasGroup

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

Checks if a specific group exists in the block.

Parameters:

nameOrId - Name or id of a group.

Returns:

True if the group exists, false otherwise.

hasGroup

@Cast(value="bool")
public boolean hasGroup(@Const @ByRef
                                            Group group)

Checks if a specific group exists in the block.

Parameters:

group - The group to check.

Returns:

True if the group exists, false otherwise.

getGroup

public Group getGroup(String nameOrId)

Retrieves a specific group from the block by its name or id.

Parameters:

nameOrId - Name or id of the group.

Returns:

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

getGroup

public Group getGroup(long index)

Retrieves a specific group by index.

Parameters:

index - The index of the group.

Returns:

The group at the specified index.

getGroupCount

@Name(value="groupCount")
public long getGroupCount()

Returns the number of groups associated with this block.

Returns:

The number of groups.

createGroup

public Group createGroup(String name,
                         String type)

Create a new group associated with this block.

Parameters:

name - The name of the group to create.

type - The type of the tag.

Returns:

The newly created group.

getGroups

public List<Group> getGroups()

List all groups within this block.

Returns:

A vector that contains all filtered groups.

getGroups

public List<Group> getGroups(java.util.function.Predicate<Group> filter)

List all groups within this block. The parameter filter can be used to filter groups by various criteria.

Parameters:

filter - A filter function.

Returns:

A vector that contains all filtered groups.

deleteGroup

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

Deletes a Group from the block. Deletes a group from the block and the file. The deletion can't be undone.

Parameters:

nameOrId - Name or id of the group to remove.

Returns:

True if the group was removed, false otherwise.

deleteGroup

@Cast(value="bool")
public boolean deleteGroup(@Const @ByRef
                                               Group group)

Deletes a group from the block. Deletes a group from the block and the file. The deletion can't be undone.

Parameters:

group - The group to remove.

Returns:

True if the group was removed, false otherwise.

hasDataArray

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

Checks if a specific data array exists in this block.

Parameters:

nameOrId - Name or id of a data array.

Returns:

True if the data array exists, false otherwise.

See Also:

DataArray

hasDataArray

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

Checks if a specific data array exists in this block.

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

Returns:

list of data arrays

See Also:

DataArray

getDataArrays

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

Get data arrays within this block.

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

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

createDataArray

public DataArray createDataArray(String name,
                                 String type,
                                 int dataType,
                                 NDSize shape)

Create a new data array associated with this block.

Parameters:

name - The name of the data array to create.

type - The type of the data array.

dataType - A DataType indicating the format to store values.

shape - A NDSize holding the extent of the array to create.

Returns:

The newly created data array.

See Also:

DataArray

deleteDataArray

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

Deletes a data array from this block.

This deletes a data array and all its dimensions from the block and the file. The deletion can't be undone.

Parameters:

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

Returns:

True if the data array was deleted, false otherwise.

See Also:

DataArray

deleteDataArray

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

Deletes a data array from this block.

This deletes a data array and all its dimensions from the block and the file. The deletion can't be undone.

Parameters:

dataArray - The data array to delete.

Returns:

True if the data array was deleted, false otherwise.

See Also:

DataArray

hasTag

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

Checks if a specific tag exists in the block.

Parameters:

nameOrId - Name or id of a tag.

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

Parameters:

tag - The tag to check.

Returns:

True if the tag exists, false otherwise.

See Also:

Tag

getTag

public Tag getTag(String nameOrId)

Retrieves a specific tag from the block 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()

Get tags within this block.

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 various criteria.

Parameters:

filter - A filter function.

Returns:

A list that contains all filtered tags.

See Also:

Tag

getTagCount

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

Returns the number of tags within this block.

Returns:

The number of tags.

createTag

public Tag createTag(String name,
                     String type,
                     double[] position)

Create a new tag associated with this block.

Parameters:

name - The name of the tag to create.

type - The type of the tag.

position - The position of the tag.

Returns:

The newly created tag.

See Also:

Tag

deleteTag

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

Deletes a tag from the block.

Deletes a tag with all its features from the block and the file. The deletion can't be undone.

Parameters:

nameOrId - Name or id of the tag to remove.

Returns:

True if the tag was removed, false otherwise.

See Also:

Tag

deleteTag

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

Deletes a tag from the block.

Deletes a tag with all its features from the block and the file. The deletion can't be undone.

Parameters:

tag - The tag to remove.

Returns:

True if the tag was removed, false otherwise.

See Also:

Tag

hasMultiTag

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

Checks if a specific multi tag exists in the block.

Parameters:

nameOrId - Name or id of a multi tag.

Returns:

True if the multi tag exists, false otherwise.

See Also:

MultiTag

hasMultiTag

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

Checks if a specific multi tag exists in the block.

Parameters:

multiTag - The multi tag to check.

Returns:

True if the multi tag exists, false otherwise.

See Also:

MultiTag

getMultiTag

public MultiTag getMultiTag(String nameOrId)

Retrieves a specific multi tag from the block by its id.

Parameters:

nameOrId - Name or id of the multi 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 multi tag by index.

Parameters:

index - The index of the tag.

Returns:

The multi tag at the specified index.

See Also:

MultiTag

getMultiTags

public List<MultiTag> getMultiTags()

Get multi tags within this block.

Returns:

A list that contains all filtered multi tags.

See Also:

MultiTag

getMultiTags

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

Get multi tags within this block.

The parameter filter can be used to filter multi tags by various * criteria.

Parameters:

filter - A filter function.

Returns:

A list that contains all filtered multi tags.

See Also:

MultiTag

getMultiTagCount

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

Returns the number of multi tags associated with this block.

Returns:

The number of multi tags.

See Also:

MultiTag

createMultiTag

public MultiTag createMultiTag(String name,
                               String type,
                               DataArray positions)

Create a new multi tag associated with this block.

Parameters:

name - The name of the multi tag to create.

type - The type of the tag.

positions - The positions of the tag.

Returns:

The newly created tag.

See Also:

MultiTag

deleteMultiTag

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

Deletes a multi tag from the block.

Deletes a multi tag and all its features from the block and the file. The deletion can't be undone.

Parameters:

nameOrId - Name or id of the tag to remove.

Returns:

True if the tag was removed, false otherwise.

See Also:

MultiTag

deleteMultiTag

@Cast(value="bool")
public boolean deleteMultiTag(@Const @ByRef
                                                  MultiTag multiTag)

Deletes a multi tag from the block.

Deletes a multi tag and all its features from the block and the file. The deletion can't be undone.

Parameters:

multiTag - The tag to remove.

Returns:

True if the tag was removed, false otherwise.

See Also:

MultiTag

toString

public String toString()

Overrides:

toString in class org.bytedeco.javacpp.Pointer