org.g_node.nix

Class Source

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

All Implemented Interfaces:

Comparable

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

Source

A class that describes the provenance of other entities of the NIX data model.

The Source is conceptually a rather simple entity. It is used to note the provenance of the data and offers the opportunity to bind additional metadata. One special feature of the Source is the possibility to contain other sources as children thus building up a tree of sources. This can, for example, be used to specify that a source electrode array contains multiple electrodes as its child sources.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Source	createSource(String name, String type) Create a new root source.
boolean	deleteSource(Source source) Delete a root source and all its child sources from the source.
boolean	deleteSource(String nameOrId) Delete a root source and all its child sources from the source.
List<Source>	findSources() Get all descendant sources of the source recursively.
List<Source>	findSources(int maxDepth) Get all descendant sources of the source recursively.
List<Source>	findSources(java.util.function.Predicate<Source> filter) Get all descendant sources of the source recursively.
List<Source>	findSources(java.util.function.Predicate<Source> filter, int maxDepth) Get all descendant sources of the source 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 source.
String	getDefinition() Getter for the definition of the source.
String	getId() Get id of the source.
Section	getMetadata() Get metadata associated with this entity.
String	getName() Getter for the name of the source.
Source	getSource(long index) Retrieves a specific source by index.
Source	getSource(String nameOrId) Retrieves a specific child source that is a direct descendant.
long	getSourceCount() Returns the number of sources that are direct descendants of this source.
List<Source>	getSources() Get all direct child sources associated with this source.
List<Source>	getSources(java.util.function.Predicate<Source> filter) Get all direct child sources associated with this source.
String	getType() Getter for the type of the source.
Date	getUpdatedAt() Get the date of the last update.
boolean	hasSource(Source source) Checks if this source has a specific source as direct descendant.
boolean	hasSource(String nameOrId) Checks if this source has a specific source as direct descendant.
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 source.
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 source.
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

Source

public Source()

Constructor that creates an uninitialized Source.

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

Specified by:

getId in class Entity

Returns:

ID string.

getCreatedAt

public Date getCreatedAt()

Get the creation date of the source.

Specified by:

getCreatedAt in class Entity

Returns:

The creation date of the source.

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

Specified by:

setType in class NamedEntity

Parameters:

type - The type of the source.

getType

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

Getter for the type of the source.

Specified by:

getType in class NamedEntity

Returns:

The type of the source.

getName

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

Getter for the name of the source.

Specified by:

getName in class NamedEntity

Returns:

The name of the source.

setDefinition

public void setDefinition(String definition)

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

Specified by:

setDefinition in class NamedEntity

Parameters:

definition - definition of source

getDefinition

public String getDefinition()

Getter for the definition of the source.

Specified by:

getDefinition in class NamedEntity

Returns:

The definition of the source.

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 source has a specific source as direct descendant.

Parameters:

nameOrId - The name or id of the source.

Returns:

True if a source with the given name/id is a direct descendant, false otherwise.

hasSource

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

Checks if this source has a specific source as direct descendant.

Parameters:

source - The Source.

Returns:

True if a source is a direct descendant, false otherwise.

getSource

public Source getSource(String nameOrId)

Retrieves a specific child source that is a direct descendant.

Parameters:

nameOrId - The name or id of the source.

Returns:

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

getSource

public Source getSource(long index)

Retrieves a specific source by index.

Parameters:

index - The index of the source.

Returns:

The source at the specified index.

getSourceCount

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

Returns the number of sources that are direct descendants of this source.

Returns:

The number of direct child sources.

getSources

public List<Source> getSources()

Get all direct child sources associated with this source.

Returns:

list of source.

getSources

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

Get all direct child sources associated with this source.

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

Parameters:

filter - A filter function.

Returns:

A list containing the matching child sources.

findSources

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

Get all descendant sources of the source recursively.

This method traverses the sub-tree of all child sources of the source. 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.

Parameters:

filter - A filter function.

maxDepth - The maximum depth of traversal.

Returns:

A list containing the matching descendant sources.

findSources

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

Get all descendant sources of the source recursively.

This method traverses the sub-tree of all child sources of the source. 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 nodes at all depths are considered.

Parameters:

filter - A filter function.

Returns:

A list containing the matching descendant sources.

findSources

public List<Source> findSources(int maxDepth)

Get all descendant sources of the source recursively.

This method traverses the sub-tree of all child sources of the source. 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 descendant sources.

findSources

public List<Source> findSources()

Get all descendant sources of the source recursively.

This method traverses the sub-tree of all child sources of the source. 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 descendant sources.

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.

deleteSource

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

Delete a root source and all its child sources from the source.

Parameters:

nameOrId - The name or id of the source to remove.

Returns:

True if the source was deleted, false otherwise.

deleteSource

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

Delete a root source and all its child sources from the source.

Parameters:

source - The Source to delete.

Returns:

True if the source was deleted, false otherwise.

toString

public String toString()

Overrides:

toString in class org.bytedeco.javacpp.Pointer