org.g_node.nix.base

Class EntityWithSources

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

All Implemented Interfaces:

Comparable

Direct Known Subclasses:

DataArray, Group, MultiTag, Tag

@Platform(value="linux") @Platform(value="windows")
public abstract class EntityWithSources
extends EntityWithMetadata

EntityWithSources

An abstract class for entities that can be associated with sources.

Constructor Summary

Constructors

Constructor and Description
EntityWithSources()

Method Summary

Modifier and Type	Method and Description
abstract void	addSource(Source source) Associate a new source with the entity.
abstract void	addSource(String id) Associate a new source with the entity.
abstract Source	getSource(long index) Retrieves an associated source identified by its index.
abstract Source	getSource(String id) Returns an associated source identified by its id.
abstract long	getSourceCount() Get the number of sources associated with this entity.
abstract List<Source>	getSources() Get all sources associated with this entity.
abstract boolean	hasSource(Source source) Checks if a specific source is associated with this entity.
abstract boolean	hasSource(String id) Checks if a specific source is associated with this entity.
abstract boolean	removeSource(Source source) Remove a source from the list of associated sources.
abstract boolean	removeSource(String id) Remove a source from the list of associated sources.
abstract void	setSources(List<Source> sources) Set all sources associations for this entity.

Methods inherited from class org.g_node.nix.base.EntityWithMetadata

getMetadata, removeMetadata, setMetadata, setMetadata

Methods inherited from class org.g_node.nix.base.NamedEntity

compareTo, getDefinition, getName, getType, setDefinition, setType

Methods inherited from class org.g_node.nix.base.Entity

equals, forceCreatedAt, forceUpdatedAt, getCreatedAt, getId, getUpdatedAt, hashCode, setCreatedAt, setUpdatedAt

Methods inherited from class org.g_node.nix.base.ImplContainer

isInitialized, isNone

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

EntityWithSources

public EntityWithSources()

Method Detail

getSourceCount

public abstract long getSourceCount()

Get the number of sources associated with this entity.

Returns:

The number sources.

hasSource

public abstract boolean hasSource(String id)

Checks if a specific source is associated with this entity.

Parameters:

id - The source id to check.

Returns:

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

hasSource

public abstract boolean hasSource(Source source)

Checks if a specific source is associated with this entity.

Parameters:

source - The source to check.

Returns:

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

getSource

public abstract Source getSource(String id)

Returns an associated source identified by its id.

Parameters:

id - The id of the associated source.

getSource

public abstract Source getSource(long index)

Retrieves an associated source identified by its index.

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.

getSources

public abstract List<Source> getSources()

Get all sources associated with this entity.

Returns:

All associated sources that match the given filter as a vector

setSources

public abstract void setSources(List<Source> sources)

Set all sources associations for this entity.

All previously existing associations will be overwritten.

Parameters:

sources - A vector with all sources.

addSource

public abstract void addSource(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.

Parameters:

id - The id of the source.

addSource

public abstract void addSource(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.

Parameters:

source - The source to add.

removeSource

public abstract boolean removeSource(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.

Parameters:

id - The id of the source to remove.

Returns:

True if the source was removed, false otherwise.

removeSource

public abstract boolean removeSource(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.

Parameters:

source - The source to remove.

Returns:

True if the source was removed, false otherwise.