Package org.rcsb.cif.model.generated

Class Software

java.lang.Object

org.rcsb.cif.model.BaseCategory

org.rcsb.cif.model.generated.Software

All Implemented Interfaces:

Category

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

Data items in the SOFTWARE category record details about the software used in the structure analysis, which implies any software used in the generation of any data items associated with the structure determination and structure representation. These data items allow computer programs to be referenced in more detail than data items in the COMPUTING category do.

Field Summary

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

isText, textFields

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
StrColumn	getCitationId()	This data item is a pointer to _citation.id in the CITATION category.
StrColumn	getClassification()	The classification of the program according to its major function.
StrColumn	getCompilerName()	The compiler used to compile the software.
StrColumn	getCompilerVersion()	The version of the compiler used to compile the software.
StrColumn	getContactAuthor()	The recognized contact author of the software.
StrColumn	getContactAuthorEmail()	The e-mail address of the person specified in _software.contact_author.
StrColumn	getDate()	The date the software was released.
StrColumn	getDependencies()	Any prerequisite software required to run _software.name.
StrColumn	getDescription()	Description of the software.
StrColumn	getHardware()	The hardware upon which the software was run.
StrColumn	getLanguage()	The major computing language in which the software is coded.
StrColumn	getLocation()	The URL for an Internet address at which details of the software can be found.
StrColumn	getMods()	Any noteworthy modifications to the base software, if applicable.
StrColumn	getName()	The name of the software.
StrColumn	getOs()	The name of the operating system under which the software runs.
StrColumn	getOsVersion()	The version of the operating system under which the software runs.
IntColumn	getPdbxOrdinal()	An ordinal index for this category
StrColumn	getType()	The classification of the software according to the most common types.
StrColumn	getVersion()	The version of the software.

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

Software

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

Software

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

Software

public Software(String name)

Method Detail

getCitationId

public StrColumn getCitationId()

This data item is a pointer to _citation.id in the CITATION category.

Returns:

StrColumn

getClassification

public StrColumn getClassification()

The classification of the program according to its major function.

Returns:

StrColumn

getCompilerName

public StrColumn getCompilerName()

The compiler used to compile the software.

Returns:

StrColumn

getCompilerVersion

public StrColumn getCompilerVersion()

The version of the compiler used to compile the software.

Returns:

StrColumn

getContactAuthor

public StrColumn getContactAuthor()

The recognized contact author of the software. This could be the original author, someone who has modified the code or someone who maintains the code. It should be the person most commonly associated with the code.

Returns:

StrColumn

getContactAuthorEmail

public StrColumn getContactAuthorEmail()

The e-mail address of the person specified in _software.contact_author.

Returns:

StrColumn

getDate

public StrColumn getDate()

The date the software was released.

Returns:

StrColumn

getDescription

public StrColumn getDescription()

Description of the software.

Returns:

StrColumn

getDependencies

public StrColumn getDependencies()

Any prerequisite software required to run _software.name.

Returns:

StrColumn

getHardware

public StrColumn getHardware()

The hardware upon which the software was run.

Returns:

StrColumn

getLanguage

public StrColumn getLanguage()

The major computing language in which the software is coded.

Returns:

StrColumn

getLocation

public StrColumn getLocation()

The URL for an Internet address at which details of the software can be found.

Returns:

StrColumn

getMods

public StrColumn getMods()

Any noteworthy modifications to the base software, if applicable.

Returns:

StrColumn

getName

public StrColumn getName()

The name of the software.

Returns:

StrColumn

getOs

public StrColumn getOs()

The name of the operating system under which the software runs.

Returns:

StrColumn

getOsVersion

public StrColumn getOsVersion()

The version of the operating system under which the software runs.

Returns:

StrColumn

getType

public StrColumn getType()

The classification of the software according to the most common types.

Returns:

StrColumn

getVersion

public StrColumn getVersion()

The version of the software.

Returns:

StrColumn

getPdbxOrdinal

public IntColumn getPdbxOrdinal()

An ordinal index for this category

Returns:

IntColumn