CDMA engine API  3.1.0
CDMA core library
org.gumtree.data.interfaces.IContainer Interface Reference

The IContainer interface is shared IGroup and IDataItem. More...

Inheritance diagram for org.gumtree.data.interfaces.IContainer:
org.gumtree.data.interfaces.IDataItem org.gumtree.data.interfaces.IGroup

List of all members.

Public Member Functions

ModelType getModelType ()
void addOneAttribute (IAttribute attribute)
void addStringAttribute (String name, String value)
IAttribute getAttribute (String name)
List< IAttributegetAttributeList ()
IDataset getDataset ()
String getLocation ()
String getName ()
IContainer getParentGroup ()
IContainer getRootGroup ()
String getShortName ()
boolean hasAttribute (String name, String value)
boolean removeAttribute (IAttribute attribute)
void setName (String name)
void setShortName (String name)
void setParent (IGroup group)
IContainer clone () throws CloneNotSupportedException

Detailed Description

The IContainer interface is shared IGroup and IDataItem.

Note:
When developing a data format engine do not implement this interface. It is inherited yet by IDataItem and IGroup interfaces.

engineAPI The IContainer contains behaviors a node, in a tree of data, should respect.

Author:
nxi

Member Function Documentation

Add an Attribute to the Group.

Parameters:
attributeCDMA Attribute
void org.gumtree.data.interfaces.IContainer.addStringAttribute ( String  name,
String  value 
)

A convenience method of adding a String type attribute.

Parameters:
nameString type object
valueString type object
IContainer org.gumtree.data.interfaces.IContainer.clone ( ) throws CloneNotSupportedException

Find an Attribute in this Group by its name.

Parameters:
namethe name of the attribute
Returns:
the attribute, or null if not found

Get the set of attributes contained directly in this Group.

Returns:
List of type Attribute; may be empty, not null.

Get the Dataset that hold the current Group.

Returns:
CDMA Dataset

Implemented in org.gumtree.data.interfaces.IGroup.

Get the location referenced by the Dataset.

Returns:
String type

Get the ModelType implemented by this object.

Returns:
ModelType of this object

Get the (long) name of the IObject, which contains the path information.

Returns:
String type object

Get its parent Group, or null if its the root group.

Returns:
CDMA group object

Implemented in org.gumtree.data.interfaces.IGroup.

Get the root group of the tree that holds the current Group.

Returns:
CDMA Group

Implemented in org.gumtree.data.interfaces.IGroup.

Get the "short" name, unique within its parent Group.

Returns:
String object
boolean org.gumtree.data.interfaces.IContainer.hasAttribute ( String  name,
String  value 
)

Check if the Group has an Attribute with certain name and value.

Parameters:
namein String type
valuein String type
Returns:
boolean type

Remove an Attribute from the Attribute list.

Parameters:
attributeCDMA Attribute
Returns:
boolean type

Implemented in org.gumtree.data.interfaces.IDataItem.

Set the IObject's (long) name.

Parameters:
nameString object

Set the parent group.

Parameters:
groupIGroup object

Set the IObject's (short) name.

Parameters:
namein String type

The documentation for this interface was generated from the following file:
 All Classes Namespaces Files Functions Variables