Package org.cip4.jdflib.extensions

Class XJMFHelper

java.lang.Object

org.cip4.jdflib.extensions.BaseXJDFHelper

org.cip4.jdflib.extensions.MessagePoolHelper

org.cip4.jdflib.extensions.XJMFHelper

public class XJMFHelper
extends MessagePoolHelper

Field Summary

Fields inherited from class org.cip4.jdflib.extensions.BaseXJDFHelper

log, theElement

Constructor Summary

Constructors

Constructor	Description
XJMFHelper()
XJMFHelper(KElement pool)

Method Summary

Modifier and Type	Method	Description
MessageHelper	appendMessage(JDFMessage.EnumFamily family, java.lang.String typ)
MessageHelper	appendMessage(JDFMessage.EnumFamily family, JDFMessage.EnumType typ)
void	cleanUp()	generic cleanup routine
MessageHelper	getCreateMessage(JDFMessage.EnumFamily family, JDFMessage.EnumType typ, int iSkip)
KElement	getHeader()	get the header of this - create if not there yet
static XJMFHelper	getHelper(KElement root)	factory to create a helper from an element
static XJMFHelper	getHelper(XMLDoc doc)	factory to create a helper from a doc
java.util.List<MessageHelper>	getMessageHelpers(MessageHelper.EFamily family)
XJMFHelper	newXJMF(JDFElement.EnumVersion v)
static XJMFHelper	parseFile(java.io.File file)
static XJMFHelper	parseFile(java.lang.String fileName)
void	setVersion(JDFElement.EnumVersion v)	default version - currently 2.0
boolean	writeToFile(java.lang.String file)
void	writeToStream(java.io.OutputStream os)

Methods inherited from class org.cip4.jdflib.extensions.MessagePoolHelper

appendMessage, getAuditHelpers, getCreateMessage, getCreateMessageResourceHelper, getMessageHelper, getMessageHelper, getMessageHelper, getMessageHelpers, getMessageResourceHelper

Methods inherited from class org.cip4.jdflib.extensions.BaseXJDFHelper

appendElement, appendElement, copyHelper, deleteNode, ensureID, equals, getAttribute, getAttributeMap, getBaseHelper, getBaseHelper, getComment, getCreateElement, getDefaultVersion, getDescriptiveName, getExternalID, getGeneralID, getID, getLocalName, getRoot, getRootDoc, getXJDFRoot, getXPathElement, getXPathValue, getXRoot, hasAttribute, hashCode, isEqual, removeAttribute, setAttribute, setAttribute, setComment, setDefaultVersion, setID, setXPathValue, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

XJMFHelper

public XJMFHelper(KElement pool)

Parameters:

pool -

XJMFHelper

public XJMFHelper()

Parameters:

pool -

Method Detail

setVersion

public void setVersion(JDFElement.EnumVersion v)

default version - currently 2.0

getMessageHelpers

public java.util.List<MessageHelper> getMessageHelpers(MessageHelper.EFamily family)

Returns:

newXJMF

public XJMFHelper newXJMF(JDFElement.EnumVersion v)

Returns:

appendMessage

public MessageHelper appendMessage(JDFMessage.EnumFamily family,
                                   JDFMessage.EnumType typ)

Parameters:

family -

typ -

Returns:

getCreateMessage

public MessageHelper getCreateMessage(JDFMessage.EnumFamily family,
                                      JDFMessage.EnumType typ,
                                      int iSkip)

Parameters:

family -

typ -

Returns:

appendMessage

public MessageHelper appendMessage(JDFMessage.EnumFamily family,
                                   java.lang.String typ)

Parameters:

family -

typ -

Returns:

writeToFile

public boolean writeToFile(java.lang.String file)

Parameters:

file -

Returns:

getHeader

public KElement getHeader()

get the header of this - create if not there yet

Returns:

cleanUp

public void cleanUp()

Description copied from class: BaseXJDFHelper

generic cleanup routine

Overrides:

cleanUp in class MessagePoolHelper

See Also:

BaseXJDFHelper.cleanUp()

writeToStream

public void writeToStream(java.io.OutputStream os)
                   throws java.io.IOException

Parameters:

os -

Throws:

java.io.IOException

getHelper

public static XJMFHelper getHelper(KElement root)

factory to create a helper from an element

Parameters:

root - the element to parse if not an XJDF - search in ancestors of element

Returns:

the helper

parseFile

public static XJMFHelper parseFile(java.lang.String fileName)

Parameters:

fileName -

Returns:

parseFile

public static XJMFHelper parseFile(java.io.File file)

Parameters:

fileName -

Returns:

getHelper

public static XJMFHelper getHelper(XMLDoc doc)

factory to create a helper from a doc

Parameters:

doc - the xmldoc to parse

Returns:

the helper