org.rcsb.mmtf.utils

Class CodecUtils

java.lang.Object

org.rcsb.mmtf.utils.CodecUtils

public class CodecUtils
extends java.lang.Object

A utility class of static methods and constants

Author:

Anthony Bradley

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_CHARS_PER_CHAIN_ENTRY The maximum number of chars in a chain entry.

Constructor Summary

Constructors

Constructor and Description
CodecUtils()

Method Summary

Modifier and Type	Method and Description
static int[]	convertToIntArray(java.util.List<java.lang.Integer> integerList) Converts an integer list to an integer array
static java.lang.String	getMmtfBaseUrl(boolean https, boolean reduced) Returns the base URL to retrieve MMTF files.
static java.lang.String	getMmtfEntryUrl(java.lang.String pdbId, boolean https, boolean reduced) Returns the RESTful URL to an MMTF encoded PDB entry.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_CHARS_PER_CHAIN_ENTRY

public static final int MAX_CHARS_PER_CHAIN_ENTRY

The maximum number of chars in a chain entry.

See Also:

Constant Field Values

Constructor Detail

CodecUtils

public CodecUtils()

Method Detail

getMmtfEntryUrl

public static java.lang.String getMmtfEntryUrl(java.lang.String pdbId,
                                               boolean https,
                                               boolean reduced)

Returns the RESTful URL to an MMTF encoded PDB entry. This methods support http and https protocols and two MMTF representations: full and reduced. reduced: C-alpha atoms for polypeptides, P for polynucleotides, and all atom for all other groups (residues) at 0.1 A coordinate precision; full: all atoms at 0.001 A coordinate precision

Parameters:

pdbId - PDB Id

https - if true, use HTTPS instead of HTTP

reduced - if true, use reduced representation of MMTF file instead of full representation

Returns:

getMmtfBaseUrl

public static java.lang.String getMmtfBaseUrl(boolean https,
                                              boolean reduced)

Returns the base URL to retrieve MMTF files.

Parameters:

https - if true, returns https URL, otherwise http URL

reduced - if true, returns URL to reduced MMTF files (C-alpha: polypeptides, P polynucleotides, all other groups: all atom, limited precision), otherwise full version (all atoms, full precision)

Returns:

base URL

convertToIntArray

public static int[] convertToIntArray(java.util.List<java.lang.Integer> integerList)

Converts an integer list to an integer array

Parameters:

integerList - the input list

Returns:

the output array