com.yworks.yfiles.graphml

Interface IOutputHandler

All Known Implementing Classes:

AbstractOutputHandler, MapperOutputHandler

public interface IOutputHandler

The interface used by the GraphMLIOHandler for writing data to the GraphML.

Method Summary

Modifier and Type	Method and Description
IEnumerable<GraphMLXmlAttribute>	getDataTagAttributes() Gets the XML attributes that should be added to the data element.
IEnumerable<GraphMLXmlAttribute>	getKeyDefinitionAttributes() Gets the XML attributes that should be added to the key definition in the GraphML key element.
WritePrecedence	getPrecedence() Gets the write precedence that is associated with this instance.
boolean	isDefaultValue(IWriteContext context) Determines whether in the current context, the value is the default value and therefore no data element needs to be written.
void	writeKeyDefinitionContent(IWriteContext context) Writes the contents of the key definition.
void	writeValue(IWriteContext context) Actually writes the value for the current context.

Method Detail

getDataTagAttributes

IEnumerable<GraphMLXmlAttribute> getDataTagAttributes()

Gets the XML attributes that should be added to the data element.

Returns:

The attributes for the data element.

getKeyDefinitionAttributes

IEnumerable<GraphMLXmlAttribute> getKeyDefinitionAttributes()

Gets the XML attributes that should be added to the key definition in the GraphML key element.

Returns:

The key definition attributes.

getPrecedence

WritePrecedence getPrecedence()

Gets the write precedence that is associated with this instance.

Registered output handlers are written either before or after the (optional) child content of the governing GraphML element.

Returns:

The write precedence for this instance.

See Also:

WritePrecedence

isDefaultValue

boolean isDefaultValue(IWriteContext context)

Determines whether in the current context, the value is the default value and therefore no data element needs to be written.

Parameters:

context - The context.

Returns:

true if for the current context the default value applies and therefore no data element needs to be written.

writeKeyDefinitionContent

void writeKeyDefinitionContent(IWriteContext context)
                        throws IOException

Writes the contents of the key definition.

At the time this method is called, the surrounding 'key' element has already been written. However no 'default' element is written by the framework.

Throws:

IOException - If the key definition cannot be written.

Parameters:

context - The context.

writeValue

void writeValue(IWriteContext context)
         throws IOException

Actually writes the value for the current context.

At the time this method is called, the surrounding 'data' element has already been written.

Throws:

IOException - If the value cannot be written.

Parameters:

context - The context.