opendap.dap.Server
Class ServerDDS

java.lang.Object
  extended by opendap.dap.BaseType
      extended by opendap.dap.DConstructor
          extended by opendap.dap.DStructure
              extended by opendap.dap.DDS
                  extended by opendap.dap.Server.ServerDDS
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, ClientIO

public class ServerDDS
extends DDS
implements java.lang.Cloneable

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.

Version:
$Revision: 23881 $
Author:
jhrg
See Also:
DDS, CEEvaluator, Serialized Form

Field Summary
 
Fields inherited from class opendap.dap.DStructure
vars
 
Constructor Summary
protected ServerDDS()
           
  ServerDDS(BaseTypeFactory factory)
          Creates an empty ServerDDS with the given BaseTypeFactory.
protected ServerDDS(java.lang.String n)
          Creates an empty Server DDS with the given dataset name.
  ServerDDS(java.lang.String n, BaseTypeFactory factory)
          Creates an empty ServerDDS with the given dataset name and BaseTypeFactory.
  ServerDDS(java.lang.String n, BaseTypeFactory factory, java.lang.String schema)
          Creates an empty DDS with the given dataset name and BaseTypeFactory.
 
Method Summary
 java.lang.Object clone()
          Return a clone of the ServerDDS.
 java.lang.String getDatasetFilename()
          Get the dataset filename.
 void printConstrained(java.io.OutputStream os)
          Print the constrained DDS on the given OutputStream.
 void printConstrained(java.io.PrintWriter os)
          Print the constrained DDS on the given PrintWriter.
 void printConstrainedXML(java.io.OutputStream os)
          Print the constrained DDS on the given OutputStream.
 void printConstrainedXML(java.io.PrintWriter pw)
          Print the constrained DDS on the given PrintWriter.
 void setDatasetFilename(java.lang.String n)
          Set the filename of the dataset.
 
Methods inherited from class opendap.dap.DDS
addVariable, checkForAttributeNameConflict, checkSemantics, delVariable, getBlobContentID, getDAS, getDDSText, getDDXText, getFactory, getVariable, getVariables, ingestDAS, normalize, numVariables, parse, parseXML, parseXML, print, print, printDAS, printDAS, printXML, printXML, resolveAliases, search, setBlobContentID, setFactory, tokenizeAliasField
 
Methods inherited from class opendap.dap.DStructure
deserialize, elementCount, externalize, getTypeName, getVar, 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, getClearName, getLongName, getName, getParent, hasAttributes, newPrimitiveVector, printAttributes, printAttributes, printAttributes, printAttributes, printDecl, printDecl, printDecl, printDecl, printDecl, printDecl, printDecl, printVal, printVal, printVal, printXML, printXML, printXML, setClearName, setName, setParent
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ServerDDS

protected ServerDDS()

ServerDDS

protected ServerDDS(java.lang.String n)
Creates an empty Server DDS with the given dataset name.

Parameters:
n - the dataset name

ServerDDS

public ServerDDS(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(java.lang.String n,
                 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(java.lang.String n,
                 BaseTypeFactory factory,
                 java.lang.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

clone

public java.lang.Object clone()
Return a clone of the ServerDDS. A deep copy is performed on this object and those it contains.

Overrides:
clone in class DDS
Returns:
a ServerDDS object.

setDatasetFilename

public void setDatasetFilename(java.lang.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()

getDatasetFilename

public java.lang.String getDatasetFilename()
Get the dataset filename.

Returns:
The filename of the dataset.
See Also:
setDatasetFilename(String)

printConstrained

public void printConstrained(java.io.PrintWriter os)
Print the constrained DDS on the given PrintWriter.

Parameters:
os - the PrintWriter to use for output.

printConstrained

public final void printConstrained(java.io.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(java.io.OutputStream os)
Print the constrained DDS on the given OutputStream.

Parameters:
os - the OutputStream to use for output.
See Also:
DDS.print(PrintWriter)

This class/method is associated with pre-release version of the DDX API. It is experimental and is subject to (significant) change.


printConstrainedXML

public void printConstrainedXML(java.io.PrintWriter pw)
Print the constrained DDS on the given PrintWriter.

Parameters:
pw - the PrintWriter to use for output.

This class/method is associated with pre-release version of the DDX API. It is experimental and is subject to (significant) change.