org.g_node.nix

Class File

java.lang.Object

org.bytedeco.javacpp.Pointer

org.g_node.nix.base.ImplContainer

org.g_node.nix.File

All Implemented Interfaces:

Comparable<File>

@Platform(include="<nix/File.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 File
extends ImplContainer
implements Comparable<File>

File

A File represents a specific data source of a NIX back-end for example an NIX HDF5 file. All entities of the nix data model (except the Value entity) must exist in the context of an open File object. Therefore NIX entities can’t be initialized via their constructors but only through the factory methods of their respective parent entity.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	close() Close the file.
int	compareTo(File file)
Block	createBlock(String name, String type) Create an new block, that is immediately persisted in the file.
Section	createSection(String name, String type) Creates a new Section with a given name and type.
boolean	deleteBlock(Block block) Deletes a block from the file.
boolean	deleteBlock(String nameOrId) Deletes a block from the file.
boolean	deleteSection(Section section) Deletes the Section.
boolean	deleteSection(String nameOrId) Deletes the Section that is specified with the id.
List<Section>	findSections(int maxDepth) Get all sections in this file recursively.
List<Section>	findSections(java.util.function.Predicate<Section> filter, int maxDepth) Get all sections in this file 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.
Block	getBlock(long index) Read an existing with block from the file, addressed by index.
Block	getBlock(String nameOrId) Read an existing block from the file.
long	getBlockCount() Get the number of blocks in in the file.
List<Block>	getBlocks() Get all blocks within this file.
List<Block>	getBlocks(java.util.function.Predicate<Block> filter) Get all blocks within this file.
Date	getCreatedAt() Get the creation date of the file.
String	getFormat() Read the format hint from the file.
String	getLocation() Return the location / uri.
Section	getSection(long index) Get root section with a given index/position.
Section	getSection(String nameOrId) Get a root section with the given name/id.
long	getSectionCount() Returns the number of root sections stored in the File.
List<Section>	getSections() Get all root sections within this file.
List<Section>	getSections(java.util.function.Predicate<Section> filter) Get all root sections within this file.
Date	getUpdatedAt() Get the date of the last update.
int[]	getVersion() Read the NIX format version from the file.
boolean	hasBlock(Block block) Check if a block exists in the file.
boolean	hasBlock(String nameOrId) Check if a block exists in the file.
boolean	hasSection(Section section) Check if a specific root section exists in the file.
boolean	hasSection(String nameOrId) Check if a specific root section exists in the file.
boolean	isNone() Check if entity is null
boolean	isOpen() Check if the file is currently open.
static File	open(String name) Opens a file in ReadWrite mode and with back-end implementation in hdf5.
static File	open(String name, int mode) Opens a file with back-end implementation in hdf5.
static File	open(String name, int mode, String impl) Opens a file.
void	setCreatedAt() Sets the creation time to the current time if the field is not set.
void	setUpdatedAt() Sets the time of the last update to the current time if the field is not set.
Result	validate() Validator.

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, equals, fill, hashCode, 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

File

public File()

Constructor that creates an uninitialized File.

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

open

@ByVal
public static File open(@StdString
                               String name,
                               @Cast(value="nix::FileMode")
                               int mode,
                               @StdString
                               String impl)

Opens a file.

Parameters:

name - The name/path of the file.

mode - The open mode. Check FileMode for options.

impl - The back-end implementation the should be used to open the file.

Returns:

The opened file.

See Also:

FileMode

open

public static File open(@StdString
                        String name,
                        int mode)

Opens a file with back-end implementation in hdf5.

Parameters:

name - The name/path of the file.

mode - The open mode. Check FileMode for options.

Returns:

The opened file.

See Also:

FileMode

open

@ByVal
public static File open(@StdString
                               String name)

Opens a file in ReadWrite mode and with back-end implementation in hdf5.

Parameters:

name - The name/path of the file.

Returns:

The opened file.

getBlockCount

@Name(value="blockCount")
public long getBlockCount()

Get the number of blocks in in the file.

Returns:

The number of blocks.

See Also:

Block

hasBlock

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

Check if a block exists in the file.

Parameters:

nameOrId - Name or ID of the block.

Returns:

True if the block exists, false otherwise.

See Also:

Block

hasBlock

@Cast(value="bool")
public boolean hasBlock(@Const @ByRef
                                            Block block)

Check if a block exists in the file.

Parameters:

block - The block to check.

Returns:

True if the block exists, false otherwise.

See Also:

Block

getBlock

@ByVal
public Block getBlock(@StdString
                             String nameOrId)

Read an existing block from the file.

Parameters:

nameOrId - Name or ID of the block.

Returns:

The block with the given name or id. Returns null if not present.

See Also:

Block

getBlock

@ByVal
public Block getBlock(@Cast(value="size_t")
                             long index)

Read an existing with block from the file, addressed by index.

Parameters:

index - The index of the block to read.

Returns:

The block at the given index. Returns null if not present.

See Also:

Block

createBlock

@ByVal
public Block createBlock(@StdString
                                String name,
                                @StdString
                                String type)

Create an new block, that is immediately persisted in the file.

Parameters:

name - The name of the block.

type - The type of the block.

Returns:

The created block.

See Also:

Block

deleteBlock

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

Deletes a block from the file.

Parameters:

nameOrId - Name or id of the block to delete.

Returns:

True if the block has been removed, false otherwise.

See Also:

Block

deleteBlock

@Cast(value="bool")
public boolean deleteBlock(@Const @ByRef
                                               Block block)

Deletes a block from the file.

Parameters:

block - The block to delete.

Returns:

True if the block has been removed, false otherwise.

See Also:

Block

getBlocks

public List<Block> getBlocks()

Get all blocks within this file.

Returns:

A list with Block entities.

See Also:

Block

getBlocks

public List<Block> getBlocks(java.util.function.Predicate<Block> filter)

Get all blocks within this file.

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

Parameters:

filter - A filter function.

Returns:

A list of filtered Block entities.

See Also:

Block

hasSection

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

Check if a specific root section exists in the file.

Parameters:

nameOrId - Name or ID of the section.

Returns:

True if the section exists, false otherwise.

See Also:

Section

hasSection

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

Check if a specific root section exists in the file.

Parameters:

section - The section to check.

Returns:

True if the section exists, false otherwise.

See Also:

Section

getSection

public Section getSection(String nameOrId)

Get a root section with the given name/id.

Parameters:

nameOrId - Name or id of the section.

Returns:

The section with the specified name/id.

See Also:

Section

getSection

public Section getSection(long index)

Get root section with a given index/position.

Parameters:

index - The index of the section.

Returns:

The section with the specified index.

See Also:

Section

getSectionCount

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

Returns the number of root sections stored in the File.

Returns:

The number of sections.

See Also:

Section

getSections

public List<Section> getSections()

Get all root sections within this file.

The parameter filter can be used to filter sections by various criteria. By default a filter is used that accepts all sections.

Returns:

A list of filtered Section entities.

See Also:

Section

getSections

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

Get all root sections within this file.

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

Parameters:

filter - A filter function.

Returns:

A list of filtered Section entities.

See Also:

Section

findSections

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

Get all sections in this file recursively.

This method traverses the trees of all section in the file. 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 sections.

See Also:

Section

findSections

public List<Section> findSections(int maxDepth)

Get all sections in this file recursively.

This method traverses the trees of all section in the file. 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. By default a filter is used that accepts all sections.

Parameters:

maxDepth - The maximum depth of traversal.

Returns:

A list containing the matching sections.

See Also:

Section

createSection

public Section createSection(String name,
                             String type)

Creates a new Section with a given name and type. Both must not be empty.

Parameters:

name - The name of the section.

type - The type of the section.

Returns:

The created Section.

See Also:

Section

deleteSection

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

Deletes the Section that is specified with the id.

Parameters:

nameOrId - Name or id of the 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 the Section.

Parameters:

section - The section to delete.

Returns:

True if the section was deleted, false otherwise.

See Also:

Section

getVersion

public int[] getVersion()

Read the NIX format version from the file.

The version consist of three integers standing for the major, minor and patch version of the nix format.

Returns:

The format version of the NIX file.

getFormat

@Name(value="format")
 @StdString
public String getFormat()

Read the format hint from the file.

Returns:

format of file.

getLocation

@Name(value="location")
 @StdString
public String getLocation()

Return the location / uri.

Returns:

The uri string.

getCreatedAt

public Date getCreatedAt()

Get the creation date of the file.

Returns:

The creation date of the file.

getUpdatedAt

public Date getUpdatedAt()

Get the date of the last update.

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.

forceUpdatedAt

public void forceUpdatedAt()

Sets the time of the last update to the current time.

setCreatedAt

public void setCreatedAt()

Sets the creation time to the current time if the field is not set.

forceCreatedAt

public void forceCreatedAt(Date date)

Sets the creation date to the provided value even if the attribute is set.

Parameters:

date - The creation date to set.

validate

@ByVal
public Result validate()

Validator.

Returns:

result

See Also:

Result

close

public void close()

Close the file.

isOpen

@Cast(value="bool")
public boolean isOpen()

Check if the file is currently open.

Returns:

True if the file is open, false otherwise.

compareTo

public int compareTo(File file)

Specified by:

compareTo in interface Comparable<File>