XMLResource (DocJGenerator API)

java.lang.Object
- org.docgene.model.XMLResource

All Implemented Interfaces:

ElementReference, NonEmptyLineAscendant, ParagraphElement, StyledElement
```
public class XMLResource
extends java.lang.Object
implements ParagraphElement, ElementReference, NonEmptyLineAscendant
```
Represent an internal link (to any file). Note that these files must be defined in directories names "doc-files". Also:
- These directories will not be parsed for wiki XML files
- Links to files defined in these directories are valid for the wiki files which have the same parent directory as the "doc-files" directory.
Example
Suppose the following structure:
```
 wiki
 ==> doc-files
 ====> reference1.html
 ==>article1.xml
 ==>subDirectory
 ====> doc-files
 ======> reference2.html
 ====>article2.xml
 
```
The "article1.xml" article can reference the "reference1.html" in the top-level "doc-files" directory, whereas the "article2.xml" article can reference the "reference2.html" in the sub-level "doc-files" directory. The syntax is:
```
 <resource href="reference1.html">the reference</resource>
 
```

Field Summary
- Fields inherited from interface org.docgene.model.StyledElement
  TYPE_NONE

Constructor Summary

Constructors
Constructor and Description
`XMLResource(XMLArticle article)` Constructor.
`XMLResource(XMLArticle article, java.lang.String id, java.lang.String pack)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`bind(org.docgene.model.globals.ResourceDefinition resource)` Bind this resource to its associated resource definition.
`void`	`bind(java.lang.String path)` Set the resource path.
`XMLArticle`	`getArticle()` Return the article in which this resource reference is used.
`java.lang.String`	`getDeclaration()` Return the declaration ID of the element.
`java.lang.String`	`getID()` Return the referenced resource ID.
`java.io.File`	`getInputFile()` Return the input File for the resource.
`int`	`getLineNumber()` Return the line where the reference appear.
`java.lang.String`	`getOutputPath()` Return the resource output path.
`java.lang.String`	`getPackage()` Return the resource reference package.
`java.lang.String`	`getPath()` Return the resource path.
`org.docgene.model.globals.ResourceDefinition`	`getResource()` Return the associated resource definition.
`java.lang.String`	`getText()` Return the resource text.
`boolean`	`hasID()` Return true if this resource reference an resource ID
`boolean`	`hasResourceDefinition()` Return true if this resource references a resource definition
`void`	`setLineNumber(int lineNumber)` Set the line number where the reference appear.
`void`	`setOutputPath(java.lang.String path)` Set the resource output path.
`void`	`setText(java.lang.String text)` Set the resource text.
`java.lang.String`	`toString()` Return the resource path.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.docgene.model.StyledElement
getCustomStyles, getInlinedStyle, getStyle, hasInlinedStyle, setCustomStyles, setCustomStyles, setInlinedStyle

Methods inherited from interface org.docgene.model.ElementReference
hasLineNumber

- Constructor Detail
  - XMLResource
```
public XMLResource(XMLArticle article)
```
    Constructor.
    
    Parameters:
    
    article - the article
  - XMLResource
```
public XMLResource(XMLArticle article,
                   java.lang.String id,
                   java.lang.String pack)
```
    Constructor.
    
    Parameters:
    
    article - the article
    
    id - the reference ID
    
    pack - the package
- Method Detail
  - setLineNumber
```
public void setLineNumber(int lineNumber)
```
    Set the line number where the reference appear.
    
    Parameters:
    
    lineNumber - the line number
  - getLineNumber
```
public int getLineNumber()
```
    Return the line where the reference appear.
    
    Specified by:
    
    getLineNumber in interface ElementReference
    
    Returns:
    
    the line number
  - getDeclaration
```
public java.lang.String getDeclaration()
```
    Return the declaration ID of the element.
    
    Specified by:
    
    getDeclaration in interface StyledElement
    
    Returns:
    
    the declaration ID of the element
  - getArticle
```
public XMLArticle getArticle()
```
    Return the article in which this resource reference is used.
    
    Returns:
    
    the article in which this resource reference is used
  - bind
```
public void bind(org.docgene.model.globals.ResourceDefinition resource)
```
    Bind this resource to its associated resource definition.
    
    Parameters:
    
    resource - the resource definition
  - getResource
```
public org.docgene.model.globals.ResourceDefinition getResource()
```
    Return the associated resource definition.
    
    Returns:
    
    the associated resource definition
  - hasResourceDefinition
```
public boolean hasResourceDefinition()
```
    Return true if this resource references a resource definition
    
    Returns:
    
    true if this resource references a resource definition
  - getInputFile
```
public java.io.File getInputFile()
```
    Return the input File for the resource.
    
    Returns:
    
    the input File
  - getID
```
public java.lang.String getID()
```
    Return the referenced resource ID. This may be null if the resource is directly defined.
    
    Returns:
    
    the referenced resource ID
  - getPackage
```
public java.lang.String getPackage()
```
    Return the resource reference package.
    
    Returns:
    
    the resource reference package
  - hasID
```
public boolean hasID()
```
    Return true if this resource reference an resource ID
    
    Returns:
    
    true if this resource reference an resource ID
  - setText
```
public void setText(java.lang.String text)
```
    Set the resource text.
    
    Parameters:
    
    text - the resource text
  - getPath
```
public java.lang.String getPath()
```
    Return the resource path. Note that it is only the name of the resource file, excluding the roots of the file.
    
    Returns:
    
    the resource path
  - getOutputPath
```
public java.lang.String getOutputPath()
```
    Return the resource output path.
    
    Returns:
    
    the resource output path
  - getText
```
public java.lang.String getText()
```
    Return the resource text.
    
    Returns:
    
    the resource text
  - bind
```
public void bind(java.lang.String path)
```
    Set the resource path. Note that it is only the name of the resource file, excluding the roots of the file.
    
    Parameters:
    
    path - the resource path
  - setOutputPath
```
public void setOutputPath(java.lang.String path)
```
    Set the resource output path.
    
    Parameters:
    
    path - the resource output path
  - toString
```
public java.lang.String toString()
```
    Return the resource path.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    the path

Class XMLResource

Example

Field Summary

Fields inherited from interface org.docgene.model.StyledElement

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.docgene.model.StyledElement

Methods inherited from interface org.docgene.model.ElementReference

Constructor Detail

XMLResource

XMLResource

Method Detail

setLineNumber

getLineNumber

getDeclaration

getArticle

bind

getResource

hasResourceDefinition

getInputFile

getID

getPackage

hasID

setText

getPath

getOutputPath

getText

bind

setOutputPath

toString