Package thredds.server.opendap.servers

Class ServerDDS

  • All Implemented Interfaces:
    Serializable, Cloneable, opendap.dap.ClientIO
    Direct Known Subclasses:
    NcDDS
    public class ServerDDS
extends opendap.dap.DDS
    ServerDDS is a specialization of DDS for the server-side of OPeNDAP. This class includes methods used to distinguish synthesized variables (variables added to the DDS by a constraint expression function), methods for CE function management and methods used to return a `constrained DDS' as part of a OPeNDAP data document.

    All of the variables contained by a ServerDDS must implement the Projection interface.

    See Also:
    DDS, CEEvaluator, Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from class opendap.dap.DAPNode

        opendap.dap.DAPNode.CloneMap

    • Field Summary

      • Fields inherited from class opendap.dap.DStructure

        variables

      • Fields inherited from class opendap.dap.DAPNode

        _nameClear, _nameEncoded, log

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected ServerDDS()  
      protected ServerDDS​(String n)
      Creates an empty Server DDS with the given dataset name.
        ServerDDS​(String n, opendap.dap.BaseTypeFactory factory)
      Creates an empty ServerDDS with the given dataset name and BaseTypeFactory.
        ServerDDS​(String n, opendap.dap.BaseTypeFactory factory, String schema)
      Creates an empty DDS with the given dataset name and BaseTypeFactory.
        ServerDDS​(opendap.dap.BaseTypeFactory factory)
      Creates an empty ServerDDS with the given BaseTypeFactory.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String getDatasetFilename()
      Get the dataset filename.
      void printConstrained​(OutputStream os)
      Print the constrained DDS on the given OutputStream.
      void printConstrained​(PrintWriter os)
      Print the constrained DDS on the given PrintWriter.
      void printConstrainedXML​(OutputStream os)
      Print the constrained DDS on the given OutputStream.
      void printConstrainedXML​(PrintWriter pw)
      Print the constrained DDS on the given PrintWriter.
      void setDatasetFilename​(String n)
      Set the filename of the dataset.

      • Methods inherited from class opendap.dap.DDS

        addVariable, checkForAttributeNameConflict, checkSemantics, cloneDAG, delVariable, getBlobContentID, getDAS, getDDSText, getDDXText, getFactory, getVariable, ingestDAS, normalize, parse, parse, parseXML, parseXML, print, print, printDAS, printDAS, printXML, printXML, resolveAliases, search, setBlobContentID, setFactory, setURL, tokenizeAliasField, toString

      • Methods inherited from class opendap.dap.DStructure

        deserialize, elementCount, externalize, getTypeName, getVar, getVarCount, getVariables, printDecl, printVal

      • Methods inherited from class opendap.dap.DConstructor

        addVariable, someChildHasAttributes

      • Methods inherited from class opendap.dap.BaseType

        addAttributeAlias, addAttributeContainer, appendAttribute, appendAttribute, appendAttributeContainer, checkSemantics, delAttribute, delAttribute, elementCount, getAttribute, getAttribute, getAttributeNames, getAttributeTable, getLongName, hasAttributes, newPrimitiveVector, printAttributes, printAttributes, printAttributes, printAttributes, printConstraint, printDecl, printDecl, printDecl, printDecl, printDecl, printDecl, printDecl, printVal, printVal, printVal, printXML, printXML, printXML, setClearName

      • Methods inherited from class opendap.dap.DAPNode

        clone, cloneDAG, getClearName, getEncodedName, getParent, isProject, setEncodedName, setParent, setProject, setProject, setProjected

    • Constructor Detail

      • ServerDDS

        protected ServerDDS()

      • ServerDDS

        protected ServerDDS​(String n)
        Creates an empty Server DDS with the given dataset name.
        Parameters:
        n - the dataset name

      • ServerDDS

        public ServerDDS​(opendap.dap.BaseTypeFactory factory)
        Creates an empty ServerDDS with the given BaseTypeFactory. This will be used for OPeNDAP servers which need to construct subclasses of the various BaseType objects to hold additional server-side information.
        Parameters:
        factory - the server BaseTypeFactory object.

      • ServerDDS

        public ServerDDS​(String n,
                 opendap.dap.BaseTypeFactory factory)
        Creates an empty ServerDDS with the given dataset name and BaseTypeFactory. This will be used for OPeNDAP servers which need to construct subclasses of the various BaseType objects to hold additional server-side information.
        Parameters:
        n - the dataset name
        factory - the server BaseTypeFactory object.

      • ServerDDS

        public ServerDDS​(String n,
                 opendap.dap.BaseTypeFactory factory,
                 String schema)
        Creates an empty DDS with the given dataset name and BaseTypeFactory. This will be used for OPeNDAP servers which need to construct subclasses of the various BaseType objects to hold additional server-side information.
        Parameters:
        n - the dataset name
        factory - the server BaseTypeFactory object.
        schema - the URL where the parser can find an instance of the OPeNDAP namespace schema.

    • Method Detail

      • setDatasetFilename

        public void setDatasetFilename​(String n)
        Set the filename of the dataset. This must be passed to the read() method of the FileIO interface. The filename of the dataset may be a real filename or may be any other string that can be used to identify for the read method how to access the data-store of which a particular variable is a member.
        Parameters:
        n - The name of the dataset.
        See Also:
        ServerMethods.read()

      • printConstrained

        public void printConstrained​(PrintWriter os)
        Print the constrained DDS on the given PrintWriter.
        Parameters:
        os - the PrintWriter to use for output.

      • printConstrained

        public final void printConstrained​(OutputStream os)
        Print the constrained DDS on the given OutputStream.
        Parameters:
        os - the OutputStream to use for output.
        See Also:
        DDS.print(PrintWriter)

      • printConstrainedXML

        public final void printConstrainedXML​(OutputStream os)
        Print the constrained DDS on the given OutputStream.
        Parameters:
        os - the OutputStream to use for output.
        See Also:
        DDS.print(PrintWriter)

      • printConstrainedXML

        public void printConstrainedXML​(PrintWriter pw)
        Print the constrained DDS on the given PrintWriter.
        Parameters:
        pw - the PrintWriter to use for output.