public abstract class CompositeItem extends Item
Item.ItemCreator, Item.ItemType
connectedBacklink, connectedItem, connectivity, DEFAULT_WEIGHT, explicitSignificance, significance, uniqueID
Constructor and Description |
---|
CompositeItem() |
Modifier and Type | Method and Description |
---|---|
protected void |
adding(Item item) |
void |
addItem(int index,
Item item)
Inserts the item at a position and increases the index of existing items
starting on this position by one
|
void |
addItem(Item item) |
protected void |
appendBodyString(StringBuilder buffer)
Override to append the item body in the canonical query language of this item.
|
CompositeItem |
clone()
Returns a deep copy of this item
|
void |
disclose(Discloser discloser) |
int |
encode(ByteBuffer buffer) |
protected void |
encodeThis(ByteBuffer buffer)
Encodes just this item, not it's usual subitems, to the given buffer.
|
protected int |
encodingArity() |
void |
ensureNotInSubtree(CompositeItem item) |
boolean |
equals(Object object)
Returns whether this item is of the same class and
contains the same state as the given item
|
Item |
getItem(int index)
Returns a subitem
|
int |
getItemCount()
Returns the number of direct ancestors of this item
|
int |
getItemIndex(Item item)
Returns the index of a subitem
|
ListIterator<Item> |
getItemIterator()
Returns a modifiable list iterator
|
int |
getTermCount() |
int |
hashCode() |
boolean |
isLocked()
Whether this composite is in a mutable state.
|
void |
lock()
Make composite immutable if this is supported.
|
Item |
removeItem(int index)
Removes the item at the given index
|
boolean |
removeItem(Item item)
Removes the given item.
|
void |
setIndexName(String index)
Sets the index name of all subitems of this
|
Item |
setItem(int index,
Item item)
Replaces the item at the given index
|
protected boolean |
shouldParenthize()
Composite items should be parenthized when not on the top level
|
addAnnotation, appendHeadingString, getAnnotation, getBytes, getCode, getCreator, getItemType, getLabel, getLanguage, getName, getParent, getWeight, hasAnnotation, hasConnectivityBackLink, hasUniqueID, isFilter, isFromSpecialToken, isProtected, isRanked, isRoot, putBytes, putString, setCreator, setFilter, setFromSpecialToken, setHasUniqueID, setLabel, setLanguage, setParent, setPositionData, setProtected, setRanked, setWeight, toString, usePositionData
public void setIndexName(String index)
setIndexName
in class Item
public void ensureNotInSubtree(CompositeItem item)
public void addItem(Item item)
protected void adding(Item item)
public void addItem(int index, Item item)
IndexOutOfBoundsException
- if the index is out of rangepublic Item getItem(int index)
index
- the (0-base) index of the item to returnIndexOutOfBoundsException
- if there is no subitem at indexpublic Item setItem(int index, Item item)
index
- the (0-base) index of the item to replaceitem
- the new itemIndexOutOfBoundsException
- if there is no item at this indexpublic int getItemIndex(Item item)
item
- The child item to find the index ofpublic Item removeItem(int index)
index
- the index of the item to removeIndexOutOfBoundsException
- if there is no item at the given indexpublic boolean removeItem(Item item)
item
- the item to removepublic int getItemCount()
public ListIterator<Item> getItemIterator()
public int encode(ByteBuffer buffer)
protected void encodeThis(ByteBuffer buffer)
encodeThis
in class Item
protected int encodingArity()
protected void appendBodyString(StringBuilder buffer)
Item
([itemName] [body])The body must be appended appended by this method.
appendBodyString
in class Item
protected boolean shouldParenthize()
shouldParenthize
in class Item
public CompositeItem clone()
public boolean equals(Object object)
public void lock()
public boolean isLocked()
public int getTermCount()
getTermCount
in class Item
Copyright © 2018. All rights reserved.