TPTP 4.5.0 Platform Project
Internal API Specification

org.eclipse.tptp.platform.report.core.internal
Class DIndexEntry

java.lang.Object
  extended by org.eclipse.tptp.platform.report.core.internal.DItem
      extended by org.eclipse.tptp.platform.report.core.internal.DItemContainer
          extended by org.eclipse.tptp.platform.report.core.internal.DIndexEntry
All Implemented Interfaces:
IDItem, IDObject, IDParagraphItem, IDTaggedItem

Deprecated. As of TPTP 4.5.0, use the TPTP Business Intelligence and Reporting Tools (BIRT) reporting infrastructure (org.eclipse.tptp.platform.report.birt).

public class DIndexEntry
extends DItemContainer
implements IDTaggedItem, IDParagraphItem

A DIndexEntry is an index entry. For example if you want to create an index of all pictures in the document, you add an entry with the property 'picture' in front of each image. A DIndex entry is an IDTaggedItem, you can reference it with an IDLink.

This item is not actually implemented by the drivers. It will be implemented in the next version.

See Also:
IDLink

Constructor Summary
DIndexEntry()
          Deprecated. Creates a DIndexEntry with a null property.
DIndexEntry(java.lang.String _prop, java.lang.Object _value)
          Deprecated. Creates a DIndexEntry with property named 'prop' and associated value 'v'.
 
Method Summary
 DPropertyStore getProperties()
          Deprecated. Return property store
 java.lang.String getTag()
          Deprecated. Returns the tag
 void setTag(java.lang.String _tag)
          Deprecated. Sets the tag.
 
Methods inherited from class org.eclipse.tptp.platform.report.core.internal.DItemContainer
clear, getChildCount, getChildOfClass, getChildPosition, getChildrenOfClass, getFirstChild, getLastChild, insertChild, isContainer, removeChild
 
Methods inherited from class org.eclipse.tptp.platform.report.core.internal.DItem
addChild, getAppliedStyle, getIterator, getNext, getParent, getRoot, getStyle, setNext, setParent, setStyle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.tptp.platform.report.core.internal.IDItem
addChild, clear, getAppliedStyle, getChildCount, getChildPosition, getFirstChild, getIterator, getLastChild, getNext, getParent, getRoot, getStyle, insertChild, isContainer, removeChild, setNext, setParent, setStyle
 
Methods inherited from interface org.eclipse.tptp.platform.report.core.internal.IDItem
addChild, clear, getAppliedStyle, getChildCount, getChildPosition, getFirstChild, getIterator, getLastChild, getNext, getParent, getRoot, getStyle, insertChild, isContainer, removeChild, setNext, setParent, setStyle
 

Constructor Detail

DIndexEntry

public DIndexEntry()
Deprecated. 
Creates a DIndexEntry with a null property.


DIndexEntry

public DIndexEntry(java.lang.String _prop,
                   java.lang.Object _value)
Deprecated. 
Creates a DIndexEntry with property named 'prop' and associated value 'v'.

Parameters:
_prop - name of the property
_value - value of the property
Method Detail

getProperties

public DPropertyStore getProperties()
Deprecated. 
Return property store


getTag

public java.lang.String getTag()
Deprecated. 
Returns the tag

Specified by:
getTag in interface IDTaggedItem

setTag

public void setTag(java.lang.String _tag)
Deprecated. 
Sets the tag.

Specified by:
setTag in interface IDTaggedItem
Parameters:
_tag - is a unique string characters.

TPTP 4.5.0 Platform Project
Internal API Specification