Package com._1c.g5.v8.dt.core.navigator.order.index

Class NavigatorOrderDescription

java.lang.Object

com._1c.g5.v8.dt.core.navigator.order.index.NavigatorOrderDescription

All Implemented Interfaces:

INavigatorOrderDescription

public class NavigatorOrderDescription
extends Object
implements INavigatorOrderDescription

The default imlementation of the INavigatorOrderDescription to store bm objects order.

Constructor Summary

Constructors

Constructor	Description
NavigatorOrderDescription()

Method Summary

Modifier and Type	Method	Description
Set<String>	getFeaturesWithOrder()	Returns the set of feature names the objects order was specified for.
int	getObjectIndex(String featureName, long bmObjectId)	Returns the index of the object with the given bm id among siblings for the given feature.
int	getObjectIndex(String featureName, org.eclipse.emf.ecore.EObject object)	Returns the index of the given object among siblings for the given feature.
Map<Long,Integer>	getObjectsOrder(String featureName)	Returns the navigator objects order associated with the given feature.
void	setObjectOrder(String featureName, long bmObjectId, int orderIndex)	Sets the navigator objects order associated with the given feature for the specified child object.
void	setObjectsOrder(String featureName, Map<Long,Integer> objectsOrder)	Sets the navigator objects order associated with the given feature.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NavigatorOrderDescription

public NavigatorOrderDescription()

Method Detail

getObjectsOrder

public Map<Long,Integer> getObjectsOrder(String featureName)

Description copied from interface: INavigatorOrderDescription

Returns the navigator objects order associated with the given feature.

Specified by:

getObjectsOrder in interface INavigatorOrderDescription

Parameters:

featureName - the feature name to get feature value objects order for, cannot be null

Returns:

the objects order, never null

getObjectIndex

public int getObjectIndex(String featureName,
                          long bmObjectId)

Description copied from interface: INavigatorOrderDescription

Returns the index of the object with the given bm id among siblings for the given feature.

Specified by:

getObjectIndex in interface INavigatorOrderDescription

Parameters:

featureName - the feature name to get feature value objects order for, cannot be null

bmObjectId - the bm object id to get index for, cannot be null

Returns:

the index among siblings or -1 if there is no object with the given id

getObjectIndex

public int getObjectIndex(String featureName,
                          org.eclipse.emf.ecore.EObject object)

Description copied from interface: INavigatorOrderDescription

Returns the index of the given object among siblings for the given feature.

Specified by:

getObjectIndex in interface INavigatorOrderDescription

Parameters:

featureName - the feature name to get feature value objects order for, cannot be null

object - the given object to get index for, cannot be null

Returns:

the index among siblings or -1 if there is no object with the given id

setObjectsOrder

public void setObjectsOrder(String featureName,
                            Map<Long,Integer> objectsOrder)

Description copied from interface: INavigatorOrderDescription

Sets the navigator objects order associated with the given feature.

Specified by:

setObjectsOrder in interface INavigatorOrderDescription

Parameters:

featureName - the feature name to update feature value objects order for, cannot be null

objectsOrder - a new objects order, cannot be null

setObjectOrder

public void setObjectOrder(String featureName,
                           long bmObjectId,
                           int orderIndex)

Description copied from interface: INavigatorOrderDescription

Sets the navigator objects order associated with the given feature for the specified child object.

Specified by:

setObjectOrder in interface INavigatorOrderDescription

Parameters:

featureName - the feature name to update feature value objects order for, cannot be null

bmObjectId - the child object bm id to set index for

orderIndex - a new order index for the specified child object

getFeaturesWithOrder

public Set<String> getFeaturesWithOrder()

Description copied from interface: INavigatorOrderDescription

Returns the set of feature names the objects order was specified for.

Specified by:

getFeaturesWithOrder in interface INavigatorOrderDescription

Returns:

the set of feature names, never null