oracle.adf.controller.metadata.model

Class ParsingContext

java.lang.Object

oracle.adf.controller.metadata.model.ParsingContext

public class ParsingContext
extends java.lang.Object

Represents contextual information for the element being parsed. This information could be used for debugging and error logging.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParsingContext.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static ParsingContext	DYNAMIC_PARSING_CONTEXT ParsingContext representing dynamic runtime metadata (e.g.
static ParsingContext	UNBOUNDED_PARSING_CONTEXT ParsingContext representing unbounded flow.
static java.lang.String	WEB_INF_ADFC_CONFIG_FILE_NAME
static ParsingContext	WEB_INF_ADFC_CONFIG_NON_MUTABLE_PARSING_CONTEXT

Constructor Summary

Constructors

Constructor and Description
ParsingContext(java.lang.String documentName, TaskFlowId taskFlowId, boolean isMutable) Constructor.
ParsingContext(java.lang.String documentName, TaskFlowId taskFlowId, java.lang.String location, boolean isMutable) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDocumentName()
java.lang.String	getLocation()
TaskFlowId	getTaskFlowId()
boolean	isCustomized() Has the underlaying document been customized?
boolean	isMobile()
boolean	isMutable()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DYNAMIC_PARSING_CONTEXT

public static final ParsingContext DYNAMIC_PARSING_CONTEXT

ParsingContext representing dynamic runtime metadata (e.g. action outcomes).

UNBOUNDED_PARSING_CONTEXT

public static final ParsingContext UNBOUNDED_PARSING_CONTEXT

ParsingContext representing unbounded flow.

WEB_INF_ADFC_CONFIG_FILE_NAME

public static final java.lang.String WEB_INF_ADFC_CONFIG_FILE_NAME

See Also:

Constant Field Values

WEB_INF_ADFC_CONFIG_NON_MUTABLE_PARSING_CONTEXT

public static final ParsingContext WEB_INF_ADFC_CONFIG_NON_MUTABLE_PARSING_CONTEXT

Constructor Detail

ParsingContext

public ParsingContext(java.lang.String documentName,
                      TaskFlowId taskFlowId,
                      boolean isMutable)

Constructor.

Parameters:

documentName - the name of the document that this element is defined in

taskFlowId - the id of the bounded task flow, or task flow template that contains this document.

isMutable - indicates whether resource corresponding to this context can be modified

ParsingContext

public ParsingContext(java.lang.String documentName,
                      TaskFlowId taskFlowId,
                      java.lang.String location,
                      boolean isMutable)

Constructor.

Parameters:

documentName - the name of the document that this element is defined in

taskFlowId - the id of the bounded task flow, or task flow template that contains this document.

location - the physical location of the document, or null

isMutable - indicates whether resource corresponding to this context can be modified

Method Detail

getDocumentName

public java.lang.String getDocumentName()

Returns:

the name of the XML document this element is defined in.

getTaskFlowId

public TaskFlowId getTaskFlowId()

Returns:

the id of the bounded task flow, or task flow template that contains this document.

isMutable

public boolean isMutable()

Returns:

true, if metadata represented by this context can be modified using DT@RT APIs.

getLocation

public java.lang.String getLocation()

Returns:

the physical location of the resource represented by this context, or null, if this information is not available from the underlying metadata store. This information can be useful for debugging.

isCustomized

public boolean isCustomized()

Has the underlaying document been customized?

Returns:

true if the framework can determine customizations have been applied to the underlaying document.

isMobile

public boolean isMobile()

Returns:

true, if metadata is part of a mobile task flow definition.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object