| java.lang.Object | ||||
| ↳ | com.pnfsoftware.jeb.core.events.JebEventSource | |||
| ↳ | com.pnfsoftware.jeb.core.units.AbstractUnit | |||
| ↳ | com.pnfsoftware.jeb.core.units.AbstractBinaryUnit | |||
| ↳ | com.pnfsoftware.jeb.core.units.AbstractInteractiveBinaryUnit | |||
Known Direct Subclasses
|
Skeleton of an interactive binary unit. Usage of this abstract class is encouraged. This unit provides a default metadata manager.
Implementors must implement their own constructor; the default constructor is used for deserialization only. Example of a typical interactive binary unit constructor:
public DerivedClass(String name, IInput input, IUnitProcessor unitProcessor, IUnitCreator parent,
IPropertyDefinitionManager pdm) {
super(..., input, ..., name, unitProcessor, parent, pdm);
...
}
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| AbstractInteractiveBinaryUnit(String mimeType, IInput input, String formatType, String name, IUnit parent) | |||||||||||
|
AbstractInteractiveBinaryUnit(String mimeType, IInput input, String formatType, String name, IUnitProcessor unitProcessor, IUnitCreator parent, IPropertyDefinitionManager pdm)
Constructor.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| IInputLocation |
addressToLocation(String address)
The skeleton implementation returns null.
| ||||||||||
| boolean |
canExecuteAction(ActionContext actionContext)
The skeleton implementation returns false.
| ||||||||||
| boolean |
executeAction(ActionContext actionContext, IActionData actionData, boolean notify)
The skeleton implementation returns false.
| ||||||||||
| boolean |
executeAction(ActionContext actionContext, IActionData actionData)
The skeleton implementation returns
executeAction(actionContext,
actionData, true). | ||||||||||
| List<Integer> |
getAddressActions(String address)
The skeleton implementation returns null.
| ||||||||||
| String |
getAddressLabel(String address)
The skeleton implementation returns null.
| ||||||||||
| Map<String, String> |
getAddressLabels()
The skeleton implementation returns null.
| ||||||||||
| String |
getAddressOfItem(long id)
The skeleton implementation returns null.
| ||||||||||
| String |
getComment(String address)
The skeleton implementation returns null.
| ||||||||||
| Map<String, String> |
getComments()
The skeleton implementation returns null.
| ||||||||||
| List<Integer> |
getGlobalActions()
The skeleton implementation returns null.
| ||||||||||
| List<Integer> |
getItemActions(long id)
The skeleton implementation returns null.
| ||||||||||
| long |
getItemAtAddress(String address)
The skeleton implementation returns 0.
| ||||||||||
| Object |
getItemObject(long id)
The skeleton implementation returns null.
| ||||||||||
| IMetadataManager |
getMetadataManager()
The skeleton implementation returns an empty metadata manager.
| ||||||||||
| List<Long> |
getRelatedItems(long id)
The skeleton implementation returns an empty list.
| ||||||||||
| boolean |
isValidAddress(String address)
The default implementation returns true IFF the address can be converted to a valid (non-zero) item id.
| ||||||||||
| String |
locationToAddress(IInputLocation location)
The skeleton implementation returns null.
| ||||||||||
| boolean |
prepareExecution(ActionContext actionContext, IActionData actionData)
The skeleton implementation returns false.
| ||||||||||
| boolean |
setComment(String address, String comment)
The skeleton implementation returns false.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
com.pnfsoftware.jeb.core.units.AbstractBinaryUnit
| |||||||||||
From class
com.pnfsoftware.jeb.core.units.AbstractUnit
| |||||||||||
From class
com.pnfsoftware.jeb.core.events.JebEventSource
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
com.pnfsoftware.jeb.core.IUnitCreator
| |||||||||||
From interface
com.pnfsoftware.jeb.core.units.IAddressableUnit
| |||||||||||
From interface
com.pnfsoftware.jeb.core.units.IBinaryUnit
| |||||||||||
From interface
com.pnfsoftware.jeb.core.units.IInteractiveUnit
| |||||||||||
From interface
com.pnfsoftware.jeb.core.units.IUnit
| |||||||||||
From interface
com.pnfsoftware.jeb.util.events.IEventSource
| |||||||||||
Constructor.
The skeleton implementation returns null.
| address | mandatory address |
|---|
The skeleton implementation returns false.
| actionContext | location context for the action |
|---|
The skeleton implementation returns false.
| actionContext | context for the action |
|---|---|
| actionData | data for the action |
| notify | true to notify clients if the action was successfully executed and the unit contents has changed |
The skeleton implementation returns
executeAction(actionContext,
actionData, true).
| actionContext | location context for the action |
|---|---|
| actionData | data for the action |
The skeleton implementation returns null.
| address | the target address |
|---|
The skeleton implementation returns null.
| address | mandatory address |
|---|
The skeleton implementation returns null.
The skeleton implementation returns null.
| id | the item id |
|---|
The skeleton implementation returns null.
| address | mandatory address |
|---|
The skeleton implementation returns null.
The skeleton implementation returns null.
The skeleton implementation returns null.
| id | the target item identifier |
|---|
The skeleton implementation returns 0.
| address | the address |
|---|
The skeleton implementation returns null.
| id | the item id |
|---|
The skeleton implementation returns an empty metadata manager.
The skeleton implementation returns an empty list.
| id | an item id |
|---|
The default implementation returns true IFF the address can be converted to a valid (non-zero) item id.
The skeleton implementation returns null.
| location | mandatory location |
|---|
The skeleton implementation returns false.
| actionContext | location context for the action |
|---|---|
| actionData | data for the action |
The skeleton implementation returns false.
| comment | the new comment; null to remove any previous comment |
|---|