Package org.cip4.jdflib.extensions

Class IntentHelper

java.lang.Object

org.cip4.jdflib.extensions.BaseXJDFHelper

org.cip4.jdflib.extensions.IntentHelper

Direct Known Subclasses:

ColorIntentHelper

public class IntentHelper
extends BaseXJDFHelper

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	INTENT	Deprecated.

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

log, theElement

Constructor Summary

Constructors

Constructor	Description
IntentHelper(KElement intent)

Method Summary

Modifier and Type	Method	Description
void	cleanUp()	generic cleanup routine
KElement	getCreateResource()
KElement	getIntent()
java.lang.String	getName()
KElement	getResource()
java.lang.String	getSpan(java.lang.String spanPath)	get the span attribute - initially try attribute, else Element/@Actual
StringArray	getSpanList(java.lang.String attName)
static boolean	isIntentResource(KElement toCheck)
static boolean	isSpanAsAttribute()
void	setSpan(java.lang.String att, java.lang.String val)
void	setSpan(java.lang.String att, java.lang.String val, java.lang.String dataType)
void	setSpan(KElement resource, java.lang.String spanPath, java.lang.String val, java.lang.String dataType)	set the span in a subelement
static void	setSpanAsAttribute(boolean bSpanAsAttribute)
java.lang.String	toString()

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, getVersion, getXJDFRoot, getXJMFRoot, getXPathElement, getXPathValue, getXRoot, hasAttribute, hashCode, isEqual, removeAttribute, setAttribute, setAttribute, setComment, setDefaultVersion, setID, setXPathValue

Methods inherited from class java.lang.Object

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

Field Detail

INTENT

@Deprecated
public static final java.lang.String INTENT

Deprecated.

See Also:

Constant Field Values

Constructor Detail

IntentHelper

public IntentHelper(KElement intent)

Parameters:

intent -

Method Detail

isIntentResource

public static boolean isIntentResource(KElement toCheck)

Parameters:

toCheck -

toString

public java.lang.String toString()

Overrides:

toString in class BaseXJDFHelper

Returns:

See Also:

Object.toString()

getIntent

public KElement getIntent()

Returns:

the "Intent" element

getResource

public KElement getResource()

Returns:

the detailed intent resource

getCreateResource

public KElement getCreateResource()

Returns:

the detailed intent resource

getName

public java.lang.String getName()

Returns:

setSpan

public void setSpan(java.lang.String att,
                    java.lang.String val,
                    java.lang.String dataType)

Parameters:

att -

val -

dataType - - if null always set as simple attribute

setSpan

public void setSpan(java.lang.String att,
                    java.lang.String val)

Parameters:

att -

val -

getSpan

public java.lang.String getSpan(java.lang.String spanPath)

get the span attribute - initially try attribute, else Element/@Actual

Parameters:

spanPath -

Returns:

getSpanList

public StringArray getSpanList(java.lang.String attName)

Parameters:

attName - the attribute

Returns:

the attribute value as a list

setSpan

public void setSpan(KElement resource,
                    java.lang.String spanPath,
                    java.lang.String val,
                    java.lang.String dataType)

set the span in a subelement

Parameters:

resource -

spanPath -

val -

dataType -

cleanUp

public void cleanUp()

Description copied from class: BaseXJDFHelper

generic cleanup routine

Overrides:

cleanUp in class BaseXJDFHelper

See Also:

BaseXJDFHelper.cleanUp()

isSpanAsAttribute

public static boolean isSpanAsAttribute()

Returns:

the bSpanAsAttribute

setSpanAsAttribute

public static void setSpanAsAttribute(boolean bSpanAsAttribute)

Parameters:

bSpanAsAttribute - the bSpanAsAttribute to set