org.g_node.nix

Class Section

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

All Implemented Interfaces:

Comparable

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

Section

Used to store metadata.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Property	createProperty(String name, int dtype) Add a new Property that does not have any Values to this Section.
Property	createProperty(String name, List<Value> values) Add a new Property with values to the Section.
Property	createProperty(String name, Value value) Add a new Property to the Section.
Section	createSection(String name, String type) Adds a new child section.
boolean	deleteProperty(Property property) Deletes the Property from this section.
boolean	deleteProperty(String nameOrId) Delete the Property identified by its name or id.
boolean	deleteSection(Section section) Deletes a subsection from this Section.
boolean	deleteSection(String nameOrId) Deletes a section from the section.
List<Section>	findRelated() Find all related sections of the section.
List<Section>	findRelated(java.util.function.Predicate<Section> filter) Find all related sections of the section.
List<Section>	findSections() Get all descendant sections of the section recursively.
List<Section>	findSections(int maxDepth) Get all descendant sections of the section recursively.
List<Section>	findSections(java.util.function.Predicate<Section> filter) Get all descendant sections of the section recursively.
List<Section>	findSections(java.util.function.Predicate<Section> filter, int maxDepth) Get all descendant sections of the section 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 section.
String	getDefinition() Getter for the definition of the section.
String	getId() Get id of the section.
List<Property>	getInheritedProperties() Returns all Properties inherited from a linked section.
Section	getLink() Get the linked section.
String	getMapping() Gets the mapping information.
String	getName() Getter for the name of the section.
Section	getParent() Returns the parent section.
List<Property>	getProperties() Get all properties of the section.
Property	getProperty(long index) Gets the property defined by its index.
Property	getProperty(String nameOrId) Gets the Property identified by its name or id.
long	getPropertyCount() Gets the number of properties of this section.
String	getRepository() Gets the repository URL.
Section	getSection(long index) Get a child section by its index.
Section	getSection(String nameOrId) Get a specific child section by its name or id.
long	getSectionCount() Get the number of child section of the section.
List<Section>	getSections() Get all direct child sections of the section.
List<Section>	getSections(java.util.function.Predicate<Section> filter) Get all direct child sections of the section.
String	getType() Getter for the type of the section.
Date	getUpdatedAt() Get the date of the last update.
boolean	hasProperty(Property property) Checks if a Property exists in this Section.
boolean	hasProperty(String nameOrId) Checks if a Property with this name/id exists in this Section.
boolean	hasSection(Section section) Checks whether a section has a certain child section.
boolean	hasSection(String nameOrId) Checks whether a section has a certain child section.
boolean	isNone() Check if entity is null
void	removeLink() Deleter for the linked section.
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 section.
void	setLink(Section link) Establish a link to another section.
void	setLink(String id) Establish a link to another section.
void	setMapping(String mapping) Sets the mapping information for this section.
void	setRepository(String repository) Set the repository in which a section of this type is defined.
void	setType(String type) Setter for the type of the section.
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

Section

public Section()

Constructor that creates an uninitialized Section.

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

Specified by:

getId in class Entity

Returns:

ID string.

getCreatedAt

public Date getCreatedAt()

Get the creation date of the section.

Specified by:

getCreatedAt in class Entity

Returns:

The creation date of the section.

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

Specified by:

setType in class NamedEntity

Parameters:

type - The type of the section.

getType

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

Getter for the type of the section.

Specified by:

getType in class NamedEntity

Returns:

The type of the section.

getName

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

Getter for the name of the section.

Specified by:

getName in class NamedEntity

Returns:

The name of the section.

setDefinition

public void setDefinition(String definition)

Setter for the definition of the section.

Specified by:

setDefinition in class NamedEntity

Parameters:

definition - definition of section. If null is passed definition is removed.

getDefinition

public String getDefinition()

Getter for the definition of the section.

Specified by:

getDefinition in class NamedEntity

Returns:

The definition of the section. Returns null if not present.

setRepository

public void setRepository(String repository)

Set the repository in which a section of this type is defined.

Usually this information is provided in the form of an URL

Parameters:

repository - URL to the repository. If null is passed repository is removed.

getRepository

public String getRepository()

Gets the repository URL.

Returns:

The URL to the repository. Returns null if not present.

setLink

@Name(value="link")
public void setLink(@StdString
                                        String id)

Establish a link to another section.

The linking section inherits the properties defined in the linked section. Properties of the same name are overridden.

Parameters:

id - The id of the section that should be linked.

See Also:

Section

setLink

@Name(value="link")
public void setLink(@Const @ByRef
                                        Section link)

Establish a link to another section.

The linking section inherits the properties defined in the linked section. Properties of the same name are overridden.

Parameters:

link - The section to link with.

See Also:

Section

getLink

public Section getLink()

Get the linked section.

Returns:

The linked section. If no section was linked a null Section will be returned.

See Also:

Section

removeLink

public void removeLink()

Deleter for the linked section.

This just removes the link between both sections, but does not remove the linked section from the file.

setMapping

public void setMapping(String mapping)

Sets the mapping information for this section.

The mapping is provided as a path or URL to another section.

Parameters:

mapping - The mapping information to this section. If null is passed mapping is removed.

getMapping

public String getMapping()

Gets the mapping information.

Returns:

The mapping information. Returns null if not present.

getParent

public Section getParent()

Returns the parent section.

Each section which is not a root section has a parent.

Returns:

The parent section. If the section has no parent, a null section will be returned.

See Also:

Section

getSectionCount

@Name(value="sectionCount")
public long getSectionCount()

Get the number of child section of the section.

Returns:

The number of child sections.

See Also:

Section

hasSection

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

Checks whether a section has a certain child section.

Parameters:

nameOrId - Name or id of requested section.

Returns:

True if the section is a child, false otherwise.

See Also:

Section

hasSection

@Cast(value="bool")
public boolean hasSection(@Const @ByRef
                                              Section section)

Checks whether a section has a certain child section.

Parameters:

section - The section to check.

Returns:

True if the section is a child, false otherwise.

See Also:

Section

getSection

public Section getSection(String nameOrId)

Get a specific child section by its name or id.

Parameters:

nameOrId - The name or the ID of the child section.

Returns:

The child section.

See Also:

Section

getSection

public Section getSection(long index)

Get a child section by its index.

Parameters:

index - The index of the child.

Returns:

The specified child section.

See Also:

Section

getSections

public List<Section> getSections()

Get all direct child sections of the section.

Returns:

list of child sections

See Also:

Section

getSections

public List<Section> getSections(java.util.function.Predicate<Section> filter)

Get all direct child sections of the section.

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

Parameters:

filter - A filter function.

Returns:

A list containing the matching child sections.

See Also:

Section

findSections

public List<Section> findSections(java.util.function.Predicate<Section> filter,
                                  int maxDepth)

Get all descendant sections of the section recursively.

This method traverses the sub-tree of all child sections of the section. The traversal is accomplished via breadth first and can be limited in depth. On each node or section a filter is applied. If the filter returns true the respective section 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 sections.

See Also:

Section

findSections

public List<Section> findSections(java.util.function.Predicate<Section> filter)

Get all descendant sections of the section recursively.

This method traverses the sub-tree of all child sections of the section. The traversal is accomplished via breadth first. On each node or section a filter is applied. If the filter returns true the respective section 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 sections.

See Also:

Section

findSections

public List<Section> findSections(int maxDepth)

Get all descendant sections of the section recursively.

This method traverses the sub-tree of all child sections of the section. The traversal is accomplished via breadth first. On each node or section a filter is applied. If the filter returns true the respective section will be added to the result list. By default a filter is used that accepts all sections.

Parameters:

maxDepth - The maximum depth of traversal.

Returns:

A list containing the matching descendant sections.

See Also:

Section

findSections

public List<Section> findSections()

Get all descendant sections of the section recursively.

This method traverses the sub-tree of all child sections of the section. The traversal is accomplished via breadth first. On each node or section a filter is applied. If the filter returns true the respective section will be added to the result list. By default a filter is used that accepts all sections at all depths.

Returns:

A list containing the matching descendant sections.

See Also:

Section

findRelated

public List<Section> findRelated(java.util.function.Predicate<Section> filter)

Find all related sections of the section.

Parameters:

filter - A filter function.

Returns:

A list containing all filtered related sections.

See Also:

Section

findRelated

public List<Section> findRelated()

Find all related sections of the section.

Returns:

A list containing all filtered related sections.

See Also:

Section

createSection

public Section createSection(String name,
                             String type)

Adds a new child section.

Parameters:

name - The name of the new section

type - The type of the section

Returns:

The new child section.

See Also:

Section

deleteSection

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

Deletes a section from the section.

Parameters:

nameOrId - Name or id of the child section to delete.

Returns:

True if the section was deleted, false otherwise.

See Also:

Section

deleteSection

@Cast(value="bool")
public boolean deleteSection(@Const @ByRef
                                                 Section section)

Deletes a subsection from this Section.

Parameters:

section - The section to delete.

Returns:

True if the section was deleted, false otherwise.

See Also:

Section

getPropertyCount

@Name(value="propertyCount")
public long getPropertyCount()

Gets the number of properties of this section.

Returns:

The number of Properties

See Also:

Property

hasProperty

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

Checks if a Property with this name/id exists in this Section.

Parameters:

nameOrId - Name or id of the property.

Returns:

True if the property exists, false otherwise.

See Also:

Property

hasProperty

@Cast(value="bool")
public boolean hasProperty(@Const @ByRef
                                               Property property)

Checks if a Property exists in this Section.

Parameters:

property - The Property to check.

Returns:

True if the property exists, false otherwise.

See Also:

Property

getProperty

public Property getProperty(String nameOrId)

Gets the Property identified by its name or id.

Parameters:

nameOrId - Name or id of the property.

Returns:

The specified property.

See Also:

Property

getProperty

public Property getProperty(long index)

Gets the property defined by its index.

Parameters:

index - The index of the property.

Returns:

The property.

See Also:

Property

getProperties

public List<Property> getProperties()

Get all properties of the section.

Returns:

list of properties.

See Also:

Property

getInheritedProperties

public List<Property> getInheritedProperties()

Returns all Properties inherited from a linked section. This list may include Properties that are locally overridden.

Returns:

All inherited properties as a list.

See Also:

Property

createProperty

public Property createProperty(String name,
                               int dtype)

Add a new Property that does not have any Values to this Section.

Parameters:

name - The name of the property.

dtype - The DataType of the property.

Returns:

The newly created property

See Also:

Property

createProperty

public Property createProperty(String name,
                               Value value)

Add a new Property to the Section.

Parameters:

name - The name of the property.

value - The Value to be stored.

Returns:

The newly created property.

See Also:

Property

createProperty

public Property createProperty(String name,
                               List<Value> values)

Add a new Property with values to the Section.

Parameters:

name - The name of the property.

values - The values of the created property.

Returns:

The newly created property.

See Also:

Property

deleteProperty

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

Delete the Property identified by its name or id.

Parameters:

nameOrId - Name or id of the property.

Returns:

True if the property was deleted, false otherwise.

See Also:

Property

deleteProperty

@Cast(value="bool")
public boolean deleteProperty(@Const @ByRef
                                                  Property property)

Deletes the Property from this section.

Parameters:

property - The Property to delete.

Returns:

True if the property was deleted, false otherwise.

See Also:

Property

toString

public String toString()

Overrides:

toString in class org.bytedeco.javacpp.Pointer