Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> jxbeans >> [ utilities overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.jxbeans.utilities
Class JXBeanModelRunner  

java.lang.Object
  org.jxbeans.AbstractJXBean
      org.jxbeans.AbstractDocumentSource
          org.jxbeans.utilities.JXBeanModelRunner

All Implemented Interfaces:

org.jxbeans.DocumentSource, java.io.Serializable

---

public class JXBeanModelRunner

extends org.jxbeans.AbstractDocumentSource

The JXBeanModelRunner JXBean will execute another JXBeanModel. This JXBean provides the means of creating JXBean "sub-processes" or "sub-routines". This JXBean works this way:

• If the model's DocumentGenerator is the SimpleDocumentGenerator, this bean will use the incoming Document to set the document for the SimpleDocumentGenerator.
• Finally, if the model has a final DocumentReadyListener and is a SimpleDocumentListener, this bean will behave as follows:
• If the parentElementExpression property has been set, the resulting document will be inserted under the element referred to by the parentElementExpression.
• If the parentElementExpression property is null, the document resulting from running the model will be sent to the DocumentReadyListeners of this bean.

The source of the JXBean model can be set in one of six ways:

• JXBeanModel
• JDOM Document
• Reader
• File
• file name (as a String)
• URL

The precedence of usage is:

1. JXBeanModel
2. JDOM Document (if the JXBeanModel is null)
3. Reader (if the Document is null)
4. File (if the Reader is null)
5. file name (as a String) (if the File is null)
6. URL (if the file name is null)

Since:

1.0

Version:

1.0

---

Field Summary
private  org.jdom.Document	document
private  java.io.File	file
private  java.lang.String	fileName
private static org.apache.log4j.Category	log
private  org.jxbeans.JXBeanModel	model
private  java.lang.String	parentElementExpression
private  java.io.Reader	reader
private  org.jxbeans.JXBeanRuntime	runtime
private  java.net.URL	url

 

Fields inherited from class org.jxbeans.AbstractDocumentSource

listeners

 

Fields inherited from class org.jxbeans.AbstractJXBean

 

Constructor Summary

JXBeanModelRunner()

 

Method Summary
void	documentReady(org.jxbeans.DocumentReadyEvent anEvent)
org.jxbeans.JXBeanModel	getModel()
org.jdom.Document	getModelDocument()
java.io.File	getModelFile()
java.lang.String	getModelFileName()
java.io.Reader	getModelReader()
java.net.URL	getModelURL()
java.lang.String	getParentElementExpression()
void	setModel(org.jxbeans.JXBeanModel aModel)           Sets the JXBean model.
void	setModelDocument(org.jdom.Document aDocument)           Sets the Document that represents a JXBean model.
void	setModelFile(java.io.File aFile)           Sets the File from which this bean will load a JXBean model.
void	setModelFileName(java.lang.String aFileName)           Sets the file name from which this bean will load a JXBean model.
void	setModelReader(java.io.Reader aReader)           Sets the Reader from which this bean will load a JXBean model.
void	setModelURL(java.net.URL aURL)           Sets the URL from which this bean will load a JXBean model.
void	setParentElementExpression(java.lang.String anXPathExpression)           Sets the XPath expression that resolves to a location in the incoming document where the resulting document from the JXBeanModel execution (if any) will be inserted.

 

Methods inherited from class org.jxbeans.AbstractDocumentSource

addDocumentReadyListener, forwardDocument, forwardDocument, getDocumentReadyListeners, logDocument, removeDocumentReadyListener

 

Methods inherited from class org.jxbeans.AbstractJXBean

getName, logErrorAndRaiseException, logMethodEntry, logMethodEntry, logMethodExit, logMethodExit, setName

 

Methods inherited from class java.lang.Object

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

 

Field Detail

log

private static org.apache.log4j.Category log

---

runtime

private transient org.jxbeans.JXBeanRuntime runtime

---

model

private transient org.jxbeans.JXBeanModel model

---

document

private transient org.jdom.Document document

---

reader

private transient java.io.Reader reader

---

file

private java.io.File file

---

fileName

private java.lang.String fileName

---

url

private java.net.URL url

---

parentElementExpression

private java.lang.String parentElementExpression

Constructor Detail

JXBeanModelRunner

public JXBeanModelRunner()

Method Detail

documentReady

public void documentReady(org.jxbeans.DocumentReadyEvent anEvent)
                   throws org.jxbeans.JXBeanException

---

setParentElementExpression

public void setParentElementExpression(java.lang.String anXPathExpression)

Sets the XPath expression that resolves to a location in the incoming document where the resulting document from the JXBeanModel execution (if any) will be inserted. The default is null, which means that the document will not be inserted into the incoming document, it will be forwarded to this bean's listeners on its own.

Since:

1.0

---

getParentElementExpression

public java.lang.String getParentElementExpression()

Since:

1.0

---

setModel

public void setModel(org.jxbeans.JXBeanModel aModel)

Sets the JXBean model.

Since:

1.0

---

getModel

public org.jxbeans.JXBeanModel getModel()

Since:

1.0

---

setModelDocument

public void setModelDocument(org.jdom.Document aDocument)

Sets the Document that represents a JXBean model.

Since:

1.0

---

getModelDocument

public org.jdom.Document getModelDocument()

Since:

1.0

---

setModelReader

public void setModelReader(java.io.Reader aReader)

Sets the Reader from which this bean will load a JXBean model.

Since:

1.0

---

getModelReader

public java.io.Reader getModelReader()

Since:

1.0

---

setModelFile

public void setModelFile(java.io.File aFile)

Sets the File from which this bean will load a JXBean model.

Since:

1.0

---

getModelFile

public java.io.File getModelFile()

Since:

1.0

---

setModelFileName

public void setModelFileName(java.lang.String aFileName)

Sets the file name from which this bean will load a JXBean model.

Since:

1.0

---

getModelFileName

public java.lang.String getModelFileName()

Since:

1.0

---

setModelURL

public void setModelURL(java.net.URL aURL)

Sets the URL from which this bean will load a JXBean model.

Since:

1.0

---

getModelURL

public java.net.URL getModelURL()

Since:

1.0

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> jxbeans >> [ utilities overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---