org.biojava.nbio.structure.io.BcifFileReader Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of biojava-structure Show documentation

The protein structure modules of BioJava.

The newest version!

package org.biojava.nbio.structure.io;

import org.biojava.nbio.structure.Structure;
import org.biojava.nbio.structure.align.util.UserConfiguration;
import org.biojava.nbio.structure.io.cif.CifStructureConverter;

import java.io.IOException;
import java.io.InputStream;

/**
 * Parse binary Cif files and provide capabilities to store them locally.
 * @author Sebastian Bittrich
 * @since 5.3.0
 */
public class BcifFileReader extends LocalPDBDirectory {
    public static final String[] CIF_SPLIT_DIR = new String[] { "data", "structures", "divided", "bcif" };
    public static final String[] CIF_OBSOLETE_DIR = new String[] { "data", "structures", "obsolete", "bcif" };

    /**
     * Constructs a new BcifFileReader, initializing the extensions member variable.
     * The path is initialized in the same way as {@link UserConfiguration},
     * i.e. to system property/environment variable {@link UserConfiguration#PDB_DIR}.
     * Both autoFetch and splitDir are initialized to false
     */
    public BcifFileReader() {
        this(null);
    }

    /**
     * Constructs a new BcifFileReader, initializing the extensions member variable.
     * The path is initialized to the given path, both autoFetch and splitDir are initialized to false.
     */
    public BcifFileReader(String path) {
        super(path);
        addExtension(".bcif");
        addExtension(".bcif.gz");
    }

    @Override
    public Structure getStructure(InputStream inStream) throws IOException {
        return CifStructureConverter.fromInputStream(inStream, getFileParsingParameters());
    }

    @Override
    protected String getFilename(String pdbId) {
        return pdbId.toLowerCase() + ".bcif";
    }

    @Override
    protected String[] getSplitDirPath() {
        return CIF_SPLIT_DIR;
    }

    @Override
    protected String[] getObsoleteDirPath() {
        return CIF_OBSOLETE_DIR;
    }
}