dap4.dap4lib

Class DMRPrinter

java.lang.Object

dap4.dap4lib.DMRPrinter

public class DMRPrinter
extends java.lang.Object

DMR Printer. Given a constraint and a Dataset, print the constrained subset of the dataset.

WARNING: the printDMR code in some cases duplicates code in dap4.dap4.Dap4Print; so changes here should be propagated.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	ALLOWFIELDMAPS
protected dap4.core.ce.CEConstraint	ce
protected dap4.core.dmr.DapDataset	dmr
protected dap4.core.util.ResponseFormat	format
protected static java.lang.String[]	GROUPSPECIAL
protected static int	NILFLAGS
protected static int	NONAME
protected static int	NONNIL
protected static int	PERLINE
protected dap4.core.util.IndentWriter	printer
protected static java.lang.String[]	RESERVEDTAGS
protected boolean	testing
protected static java.lang.String[]	VARSPECIAL
protected java.io.PrintWriter	writer
protected static int	XMLESCAPED

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DMRPrinter()
	DMRPrinter(dap4.core.dmr.DapDataset dmr, dap4.core.ce.CEConstraint ce, java.io.PrintWriter writer, dap4.core.util.ResponseFormat format)
	DMRPrinter(dap4.core.dmr.DapDataset dmr, java.io.PrintWriter writer)

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush()
static java.lang.String	fqnXMLEscape(java.lang.String fqn) XML escape a dap fqn and converting '"' to " Assumes backslash escapes are in effect for '/' and '.'
protected static java.lang.String	getPrintValue(java.lang.Object value)
protected static boolean	hasDimensions(dap4.core.dmr.DapVariable var)
protected static boolean	hasMaps(dap4.core.dmr.DapVariable var)
protected boolean	hasMetadata(dap4.core.dmr.DapNode node)
void	print() Print a DapDataset: - as DMR - optionally constrained
protected void	printContainerAttribute(dap4.core.dmr.DapAttribute attr)
protected void	printMetadata(dap4.core.dmr.DapNode node)
void	printNode(dap4.core.dmr.DapNode node) Print an arbitrary DapNode and its subnodes as if it is being sent to a client with optional constraint; inclusions are determined by the view.
protected void	printOtherXML(dap4.core.dmr.DapAttribute attr)
protected void	printReserved(dap4.core.dmr.DapNode node)
protected void	printXMLAttribute(java.lang.String name, java.lang.String value, int flags) PrintXMLAttributes helper function
void	testprint() Same as print() except certain items of information are suppressed.

Methods inherited from class java.lang.Object

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

Field Detail

NILFLAGS

protected static final int NILFLAGS

See Also:

Constant Field Values

PERLINE

protected static final int PERLINE

See Also:

Constant Field Values

NONAME

protected static final int NONAME

See Also:

Constant Field Values

NONNIL

protected static final int NONNIL

See Also:

Constant Field Values

XMLESCAPED

protected static final int XMLESCAPED

See Also:

Constant Field Values

GROUPSPECIAL

protected static final java.lang.String[] GROUPSPECIAL

VARSPECIAL

protected static final java.lang.String[] VARSPECIAL

RESERVEDTAGS

protected static final java.lang.String[] RESERVEDTAGS

ALLOWFIELDMAPS

public static final boolean ALLOWFIELDMAPS

See Also:

Constant Field Values

writer

protected java.io.PrintWriter writer

printer

protected dap4.core.util.IndentWriter printer

dmr

protected dap4.core.dmr.DapDataset dmr

ce

protected dap4.core.ce.CEConstraint ce

format

protected dap4.core.util.ResponseFormat format

testing

protected boolean testing

Constructor Detail

DMRPrinter

protected DMRPrinter()

DMRPrinter

public DMRPrinter(dap4.core.dmr.DapDataset dmr,
                  java.io.PrintWriter writer)

DMRPrinter

public DMRPrinter(dap4.core.dmr.DapDataset dmr,
                  dap4.core.ce.CEConstraint ce,
                  java.io.PrintWriter writer,
                  dap4.core.util.ResponseFormat format)

Method Detail

flush

public void flush()

close

public void close()

print

public void print()
           throws java.io.IOException

Print a DapDataset: - as DMR - optionally constrained

Throws:

java.io.IOException

testprint

public void testprint()
               throws java.io.IOException

Same as print() except certain items of information are suppressed.

Throws:

java.io.IOException

printNode

public void printNode(dap4.core.dmr.DapNode node)
               throws java.io.IOException

Print an arbitrary DapNode and its subnodes as if it is being sent to a client with optional constraint; inclusions are determined by the view.

Handling newlines is a bit tricky because they may be embedded for e.g. groups, enums, etc. So the rule is that the last newline is elided and left for the caller to print. Exceptions: printMetadata printDimrefs, printMaps

Parameters:

node - - the node to print

Throws:

java.io.IOException - Note that the PrintWriter is global.

printXMLAttribute

protected void printXMLAttribute(java.lang.String name,
                                 java.lang.String value,
                                 int flags)
                          throws dap4.core.util.DapException

PrintXMLAttributes helper function

Parameters:

name -

value -

flags -

Throws:

dap4.core.util.DapException

printReserved

protected void printReserved(dap4.core.dmr.DapNode node)
                      throws dap4.core.util.DapException

Throws:

dap4.core.util.DapException

printMetadata

protected void printMetadata(dap4.core.dmr.DapNode node)
                      throws java.io.IOException

Throws:

java.io.IOException

printContainerAttribute

protected void printContainerAttribute(dap4.core.dmr.DapAttribute attr)

printOtherXML

protected void printOtherXML(dap4.core.dmr.DapAttribute attr)

fqnXMLEscape

public static java.lang.String fqnXMLEscape(java.lang.String fqn)

XML escape a dap fqn and converting '"' to " Assumes backslash escapes are in effect for '/' and '.'

Parameters:

fqn - the backslash escaped fqn

Returns:

escaped string

getPrintValue

protected static java.lang.String getPrintValue(java.lang.Object value)

hasMetadata

protected boolean hasMetadata(dap4.core.dmr.DapNode node)

hasMaps

protected static boolean hasMaps(dap4.core.dmr.DapVariable var)

hasDimensions

protected static boolean hasDimensions(dap4.core.dmr.DapVariable var)