CDMA plugin API  3.1.0
CDMA core library
org.gumtree.data.dictionary.impl.LogicalGroup Class Reference

Inherits ILogicalGroup.

List of all members.

Public Member Functions

 LogicalGroup (IKey key, IDataset dataset)
 LogicalGroup (IKey key, IDataset dataset, boolean exception)
 LogicalGroup (ILogicalGroup parent, IKey key, IDataset dataset)
 LogicalGroup (ILogicalGroup parent, IKey key, IDataset dataset, boolean exception)
ILogicalGroup clone ()
ModelType getModelType ()
ILogicalGroup getParentGroup ()
ILogicalGroup getRootGroup ()
String getShortName ()
String getLocation ()
String getName ()
IExtendedDictionary getDictionary ()
void setDictionary (IDictionary dictionary)
IDataItem getDataItem (IKey key)
IDataItem getDataItem (String keyPath)
List< IDataItemgetDataItemList (IKey key)
List< IDataItemgetDataItemList (String keyPath)
ILogicalGroup getGroup (IKey key)
ILogicalGroup getGroup (String keyPath)
List< IPathParameter > getParameterValues (IKey key)
IDataset getDataset ()
List< String > getKeyNames (ModelType model)
IKey bindKey (String bind, IKey key)
void setParent (ILogicalGroup group)
String getFactoryName ()
boolean hasAttribute (String name, String value)
boolean removeAttribute (IAttribute attribute)
void setName (String name)
void setParent (IGroup group)
void setShortName (String name)
void addOneAttribute (IAttribute attribute)
void addStringAttribute (String name, String value)
IAttribute getAttribute (String name)
List< IAttributegetAttributeList ()
IExtendedDictionary findAndReadDictionary ()

Static Public Attributes

static final String KEY_PATH_SEPARATOR = ":"

Protected Member Functions

List< IContainerresolvePath (IKey key, IPath path)
 protected methods
List< IContainerresolveMethod (IKey key, IPathMethod method, List< IContainer > input, IPath path)

Package Functions

boolean isRoot ()

Constructor & Destructor Documentation

org.gumtree.data.dictionary.impl.LogicalGroup.LogicalGroup ( IKey  key,
IDataset  dataset,
boolean  exception 
) [inline]
org.gumtree.data.dictionary.impl.LogicalGroup.LogicalGroup ( ILogicalGroup  parent,
IKey  key,
IDataset  dataset 
) [inline]
org.gumtree.data.dictionary.impl.LogicalGroup.LogicalGroup ( ILogicalGroup  parent,
IKey  key,
IDataset  dataset,
boolean  exception 
) [inline]

Member Function Documentation

void org.gumtree.data.dictionary.impl.LogicalGroup.addStringAttribute ( String  name,
String  value 
) [inline]

Bind the given key with the given name, so the key can be accessed by the bind

Parameters:
bindvalue with which we can get the key
keykey object to be mapped by the bind value
Returns:
the given key

This method defines the way the IExtendedDictionary will be loaded. It must manage the do the detection and loading of the key file, and the corresponding mapping file that belongs to the plug-in. Once the dictionary has its paths targeting both key and mapping files set, the detection work is done. It just remains the loading of those files using the IExtendedDictionary.

Returns:
IExtendeddictionary instance, that has already loaded keys and paths
Note:
IExtendedDictionary.readEntries() is already implemented in the core

Find the IDataItem corresponding to the given key in the dictionary.

Parameters:
keyentry of the dictionary (can carry filters)
Returns:
the first encountered IDataItem that match the key, else null

Find the IDataItem corresponding to the given key in the dictionary.

Parameters:
keyPathseparated entries of the dictionary (can't carry filters)
Returns:
the first encountered IDataItem that match the key, else null
Note:
keyPath can contain several keys concatenated with a plug-in's separator

Find all IDataItems corresponding to the given key in the dictionary.

Parameters:
keyentry of the dictionary (can carry filters)
Returns:
a list of IDataItem that match the key

Find all IDataItems corresponding to the given path of key in the dictionary.

Parameters:
keyPathseparated entries of the dictionary (can't carry filters)
Returns:
a list of IDataItem that match the key
Note:
keyPath can contain several keys concatenated with a plug-in's separator

Get the IDataset that hold the current Group.

Returns:
CDMA IDataset

Get the dictionary belonging to this ILogicalGroup.

Returns:
IDictionary the dictionary currently applied to this group

Find the Group corresponding to the given key in the dictionary.

Parameters:
keyentry name of the dictionary
Returns:
the first encountered ILogicalGroup that matches the key, else null
ILogicalGroup org.gumtree.data.dictionary.impl.LogicalGroup.getGroup ( String  keyPath) [inline]

Find the Group corresponding to the given key in the dictionary.

Parameters:
keyPathseparated entries of the dictionary (can't carry filters)
Returns:
the first encountered ILogicalGroup that matches the key, else null
Note:
keyPath can contain several keys concatenated with a plug-in's separator
List<String> org.gumtree.data.dictionary.impl.LogicalGroup.getKeyNames ( ModelType  model) [inline]

Return the list of key that match the given model type.

Parameters:
modelwhich kind of keys (ie: IDataItem, Group, ILogical, Attribute...)
Returns:
List of type Group; may be empty, not null.

Return the list of parameters we can set on the given key that will have an occurrence in the dataset.

Parameters:
keyIKey for which we want the parameters values
Returns:
List<IPathParameter> that can be directly applied on the key
Note:
EXPERIMENTAL METHOD do note use/implements
if the path that matches the key hold several different parameters the method will return the FIRST undefined parameter. To know deeper parameters, user has to set some IPathParameter on the key and call again this method
boolean org.gumtree.data.dictionary.impl.LogicalGroup.hasAttribute ( String  name,
String  value 
) [inline]

Check if this is the logical root.

Returns:
true or false
List<IContainer> org.gumtree.data.dictionary.impl.LogicalGroup.resolveMethod ( IKey  key,
IPathMethod  method,
List< IContainer input,
IPath  path 
) [inline, protected]
List<IContainer> org.gumtree.data.dictionary.impl.LogicalGroup.resolvePath ( IKey  key,
IPath  path 
) [inline, protected]

protected methods

Get all objects that match the given path parameterized by the given key

Parameters:
keycan contain some parameters
pathin string to be open
Returns:
list of IObject corresponding to path and key
Exceptions:
NoResultException

Set a dictionary to this ILogicalGroup.

Parameters:
dictionarythe dictionary to set
void org.gumtree.data.dictionary.impl.LogicalGroup.setParent ( ILogicalGroup  group) [inline]

Set the given logical group as parent of this logical group

Parameters:
groupILogicalGroup

Member Data Documentation


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