Package writer2latex.bibtex

Class BibTeXDocument

  • All Implemented Interfaces:
    OutputFile, Document
    public class BibTeXDocument
extends java.lang.Object
implements Document

    Class representing a BibTeX document.

    • Constructor Summary

      Constructors 
      Constructor Description
      BibTeXDocument​(java.lang.String sName)
      Constructs a new BibTeX Document.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean containsKey​(java.lang.String sIdentifier)  
      java.lang.String getExportName​(java.lang.String sIdentifier)  
      static java.lang.String getFieldName​(int nField)
      Return BibTeX name of field
      java.lang.String getFileName()
      Returns the Document name with file extension.
      java.lang.String getName()
      Returns the Document name with no file extension.
      void put​(BibMark entry)  
      void read​(java.io.InputStream is)
      This method is supposed to read byte data from the InputStream.
      void write​(java.io.OutputStream os)
      Writes out the Document content to the specified OutputStream.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • BibTeXDocument

        public BibTeXDocument​(java.lang.String sName)

        Constructs a new BibTeX Document.

        This new document is empty. Bibliographic data must added using the put method.

        Parameters:
        sName - The name of the BibTeXDocument.

    • Method Detail

      • read

        public void read​(java.io.InputStream is)
          throws java.io.IOException

        This method is supposed to read byte data from the InputStream. Currently it does nothing, since we don't need it.

        Specified by:
        read in interface Document
        Parameters:
        is - InputStream containing a BibTeX data file.
        Throws:
        java.io.IOException - In case of any I/O errors.

      • getName

        public java.lang.String getName()

        Returns the Document name with no file extension.

        Specified by:
        getName in interface Document
        Returns:
        The Document name with no file extension.

      • getFileName

        public java.lang.String getFileName()

        Returns the Document name with file extension.

        Specified by:
        getFileName in interface OutputFile
        Returns:
        The Document name with file extension.

      • write

        public void write​(java.io.OutputStream os)
           throws java.io.IOException

        Writes out the Document content to the specified OutputStream.

        This method may not be thread-safe. Implementations may or may not synchronize this method. User code (i.e. caller) must make sure that calls to this method are thread-safe.

        Specified by:
        write in interface OutputFile
        Parameters:
        os - OutputStream to write out the Document content.
        Throws:
        java.io.IOException - If any I/O error occurs.

      • getFieldName

        public static final java.lang.String getFieldName​(int nField)

        Return BibTeX name of field

      • containsKey

        public boolean containsKey​(java.lang.String sIdentifier)

      • put

        public void put​(BibMark entry)

      • getExportName

        public java.lang.String getExportName​(java.lang.String sIdentifier)