AbstractUnitRepresentation
extends Objectimplements IUnitDocumentPresentation
| java.lang.Object | |
| ↳ | com.pnfsoftware.jeb.core.output.AbstractUnitRepresentation |
 Known Direct Subclasses
|
Class Overview
A skeleton class for unit document presentations.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
AbstractUnitRepresentation(String label)
Create a new non-default document presentation.
| |||||||||||
|
AbstractUnitRepresentation(String label, boolean defaultRepresentation)
Create a new document presentation.
| |||||||||||
|
AbstractUnitRepresentation(long id, String label, boolean defaultRepresentation)
Create a new document presentation.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| long |
getId()
Get a unique identifier for the document across all documents generated by the unit
formatter.
| ||||||||||
| String |
getLabel()
Get the label for that document.
| ||||||||||
| boolean |
isDefaultRepresentation()
Determine if the document is the default representation for that unit.
| ||||||||||
| String | toString() | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
java.lang.Object
| |||||||||||
|
From interface
com.pnfsoftware.jeb.core.output.IUnitDocumentPresentation
| |||||||||||
Public Constructors
public AbstractUnitRepresentation (String label)
Create a new non-default document presentation. The identifier will be determined automatically.
public AbstractUnitRepresentation (String label, boolean defaultRepresentation)
Create a new document presentation. The identifier will be determined automatically.
public AbstractUnitRepresentation (long id, String label, boolean defaultRepresentation)
Create a new document presentation.
Parameters
| id | identifier |
|---|---|
| label | label |
| defaultRepresentation | indicates whether this representation should be the default one for the unit |
Public Methods
public long getId ()
Get a unique identifier for the document across all documents generated by the unit formatter.
Planned extension: Document identifiers will be used by plugins to provide inter-document navigation information to clients. Additional information: Currently, inter-document navigation is entirely the client's responsibility, which may or may not decide, based on knowledge and unit-specific data, incomplete or partial, to add support for it. When the extension is implemented, plugins implementors will have a formal way to specify how documents are linked to one another, and how a client may navigate through them.
Returns
- the optional identifier, 0 if none
public String getLabel ()
Get the label for that document.
Returns
- the optional label
public boolean isDefaultRepresentation ()
Determine if the document is the default representation for that unit.
Returns
- true if this presentation is the default, false otherwise.