magpie.data.utilities.output

Class CompositionOutput

java.lang.Object

magpie.data.utilities.output.BaseDatasetOutput

magpie.data.utilities.output.PropertiesOutput

magpie.data.utilities.output.CompositionOutput

All Implemented Interfaces:

Options

public class CompositionOutput
extends PropertiesOutput

Output the fraction of each element in a material. Prints into CSV format and writes all measured and predicted properties (similar to PropertiesOutput. There are a few options for controlling which elements are included in output:

1. All 113 known elements
2. A user-defined list of elements
3. All elements present in certain dataset

Usage: <-all|-dataset|-list|-dynamic> [<options...>]
-all: Print out fractions of all elements, no options
-dataset: Print out all elements that are present in a certain dataset, which is provided as the only option
-list: Print out only elements in a certain list, which is provided as options to the command
-dynamic: Print out only elements in the in the dataset being print, no options

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CompositionOutput.ElementSelectionMethod How to determine which elements to print

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.SortedSet<java.lang.Integer>	ElementsToPrint User-defined set of elements to print
protected CompositionOutput.ElementSelectionMethod	SelectionMethod Method used to determine which elements to select

Constructor Summary

Constructors

Constructor and Description
CompositionOutput()

Method Summary

Modifier and Type	Method and Description
void	addAllElementsInDataset(CompositionDataset data) Add all elements present in a dataset to the list of elements being printed.
void	addElement(int id) Add element to the list of elements being printed.
void	addElement(java.lang.String elem) Add element to the list of elements being printed
void	addElements(java.util.Collection<java.lang.Integer> ids) Add several elements to the list of elements being printed.
void	addElementsByName(java.util.Collection<java.lang.String> elems) Add several elements to the list of elements being printed.
void	clearSelectedElementList() Clear the list of user-specific elements
protected void	printAttributeNames(Dataset data, java.io.PrintWriter fp) Print out attribute names
protected void	printEntryAttributes(MultiPropertyEntry entryPtr, java.io.PrintWriter fp) Print out attributes of an entry
void	printHeader(Dataset dataPtr, java.io.OutputStream output) Write header to output.
java.lang.String	printUsage() Print out required format for options.
void	setOptions(java.util.List<java.lang.Object> Options) Set any options for this object.
void	setSelectionMethod(CompositionOutput.ElementSelectionMethod method) Set the method used to determine which elements to print.

Methods inherited from class magpie.data.utilities.output.PropertiesOutput

printEnd, printEntries, printEntryProperties

Methods inherited from class magpie.data.utilities.output.BaseDatasetOutput

writeDataset, writeDataset, writeDataset

Methods inherited from class java.lang.Object

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

Field Detail

SelectionMethod

protected CompositionOutput.ElementSelectionMethod SelectionMethod

Method used to determine which elements to select

ElementsToPrint

protected java.util.SortedSet<java.lang.Integer> ElementsToPrint

User-defined set of elements to print

Constructor Detail

CompositionOutput

public CompositionOutput()

Method Detail

setOptions

public void setOptions(java.util.List<java.lang.Object> Options)
                throws java.lang.Exception

Description copied from interface: Options

Set any options for this object. If parsing the options fails, return an Exception with the usage as its message.

Specified by:

setOptions in interface Options

Overrides:

setOptions in class PropertiesOutput

Parameters:

Options - Array of options as Objects - can be null

Throws:

java.lang.Exception - if problem with inputs

printUsage

public java.lang.String printUsage()

Description copied from interface: Options

Print out required format for options. For consistency, should start with "Usage: ".

Specified by:

printUsage in interface Options

Overrides:

printUsage in class PropertiesOutput

Returns:

Usage for this function

setSelectionMethod

public void setSelectionMethod(CompositionOutput.ElementSelectionMethod method)

Set the method used to determine which elements to print.

Parameters:

method - Desired method

clearSelectedElementList

public void clearSelectedElementList()

Clear the list of user-specific elements

addElement

public void addElement(int id)

Add element to the list of elements being printed.

Parameters:

id - ID number of element (Z - 1)

addElements

public void addElements(java.util.Collection<java.lang.Integer> ids)

Add several elements to the list of elements being printed.

Parameters:

ids - Collection of element ID #s (Z-1)

addElement

public void addElement(java.lang.String elem)

Add element to the list of elements being printed

Parameters:

elem - Abbreviation of element (e.g., Fe)

addElementsByName

public void addElementsByName(java.util.Collection<java.lang.String> elems)

Add several elements to the list of elements being printed. This will change the element selection mode to CompositionOutput.ElementSelectionMethod.USER_DEFINED.

Parameters:

elems - List of element abbreviations (e.g., Fe)

addAllElementsInDataset

public void addAllElementsInDataset(CompositionDataset data)

Add all elements present in a dataset to the list of elements being printed. Note: You may want to change the element selection mode to CompositionOutput.ElementSelectionMethod.USER_DEFINED

Parameters:

data - Dataset containing elements to be printed

printHeader

public void printHeader(Dataset dataPtr,
                        java.io.OutputStream output)

Description copied from class: BaseDatasetOutput

Write header to output. This generally describes the names of attributes

Overrides:

printHeader in class PropertiesOutput

Parameters:

dataPtr - Dataset to be written

output - Output stream

printAttributeNames

protected void printAttributeNames(Dataset data,
                                   java.io.PrintWriter fp)

Description copied from class: PropertiesOutput

Print out attribute names

Overrides:

printAttributeNames in class PropertiesOutput

Parameters:

data - Dataset being printed

fp - Output stream

printEntryAttributes

protected void printEntryAttributes(MultiPropertyEntry entryPtr,
                                    java.io.PrintWriter fp)

Description copied from class: PropertiesOutput

Print out attributes of an entry

Overrides:

printEntryAttributes in class PropertiesOutput

Parameters:

entryPtr - Entry to be printed

fp - Output stream