Package org.rcsb.cif.model.generated

Class IhmExternalFiles

java.lang.Object

org.rcsb.cif.model.BaseCategory

org.rcsb.cif.model.generated.IhmExternalFiles

All Implemented Interfaces:

Category

@Generated("org.rcsb.cif.generator.SchemaGenerator")
public class IhmExternalFiles
extends BaseCategory

Category provides details regarding external files. The IHM_EXTERNAL_REFERENCE_INFO category captures the top-level details regarding external data sources. This category captures the specific details regarding externally stored files related to the particular I/H model entry.

Field Summary

Fields inherited from class org.rcsb.cif.model.BaseCategory

isText, textFields

Constructor Summary

Constructors

Constructor	Description
IhmExternalFiles(String name)
IhmExternalFiles(String name, int rowCount, Object[] encodedColumns)
IhmExternalFiles(String name, Map<String,Column> columns)

Method Summary

Modifier and Type	Method	Description
StrColumn	getContentType()	The type of content in the file.
StrColumn	getDetails()	Textual description of what the external file is.
StrColumn	getFileFormat()	Format of the external file.
StrColumn	getFilePath()	The relative path (including filename) for each external file.
FloatColumn	getFileSizeBytes()	Storage size of the external file in bytes.
IntColumn	getId()	A unique identifier for each external file.
IntColumn	getReferenceId()	A pointer to the source of the external file - either DOI or locally stored.

Methods inherited from class org.rcsb.cif.model.BaseCategory

getBinaryColumn, getCategoryName, getColumn, getColumnNames, getRowCount, isDefined

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.rcsb.cif.model.Category

columnNames, columns, get

Constructor Detail

IhmExternalFiles

public IhmExternalFiles(String name,
                        Map<String,Column> columns)

IhmExternalFiles

public IhmExternalFiles(String name,
                        int rowCount,
                        Object[] encodedColumns)

IhmExternalFiles

public IhmExternalFiles(String name)

Method Detail

getId

public IntColumn getId()

A unique identifier for each external file.

Returns:

IntColumn

getReferenceId

public IntColumn getReferenceId()

A pointer to the source of the external file - either DOI or locally stored. This data item is a pointer to _ihm_external_reference_info.reference_id in the IHM_EXTERNAL_REFERENCE_INFO category.

Returns:

IntColumn

getFilePath

public StrColumn getFilePath()

The relative path (including filename) for each external file. Absolute paths (starting with "/") are not permitted. This is required for identifying individual files from within a tar-zipped archive file or for identifying supplementary local files organized within a directory structure. This data item assumes a POSIX-like directory structure or file path.

Returns:

StrColumn

getFileFormat

public StrColumn getFileFormat()

Format of the external file.

Returns:

StrColumn

getContentType

public StrColumn getContentType()

The type of content in the file.

Returns:

StrColumn

getFileSizeBytes

public FloatColumn getFileSizeBytes()

Storage size of the external file in bytes.

Returns:

FloatColumn

getDetails

public StrColumn getDetails()

Textual description of what the external file is.

Returns:

StrColumn