IBM Rational Software Modeler
Release 6.0

com.ibm.xtools.notation
Interface SortingStyle

All Superinterfaces:
org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier, Style
All Known Subinterfaces:
UMLListCompartmentStyle

public interface SortingStyle
extends Style

A representation of the model object 'Sorting Style'.

The sorting style is a style to be installed on nodes representing lists to be sorted

The following features are supported:

See Also:
NotationPackage.getSortingStyle()

Method Summary
 org.eclipse.emf.common.util.EList getSortedObjects()
          Returns the value of the 'Sorted Objects' reference list.
 Sorting getSorting()
          Returns the value of the 'Sorting' attribute.
 Map getSortingKeys()
          Returns the value of the 'Sorting Keys' attribute
 void setSorting(Sorting value)
          Sets the value of the 'Sorting' attribute
 void setSortingKeys(Map value)
          Sets the value of the 'Sorting Keys' attribute
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Method Detail

getSorting

public Sorting getSorting()
Returns the value of the 'Sorting' attribute. The default value is "None". The literals are from the enumeration Sorting.

This is the type of sorting applied to the list represented by the node

Returns:
the value of the 'Sorting' attribute.
See Also:
Sorting, setSorting(Sorting), NotationPackage.getSortingStyle_Sorting()

setSorting

public void setSorting(Sorting value)
Sets the value of the 'Sorting' attribute.

This is the type of sorting applied to the list represented by the node

Parameters:
value - the new value of the 'Sorting' attribute.
See Also:
Sorting, getSorting()

getSortingKeys

public Map getSortingKeys()
Returns the value of the 'Sorting Keys' attribute.

The property is an ordered map of sorting string keys to their SortingDirection. The key strings are user-defined and normally used when the Sorting property is set to Automatic The value is a non-modifiable map of java.lang.String objects to com.ibm.xtools.notation.SortingDirection objects Any attempt to change the returned map will result in UnsupportedOperationException thrown; instead use setSortingKeys to change the map

Returns:
the value of the 'Sorting Keys' attribute.
See Also:
setSortingKeys(Map), NotationPackage.getSortingStyle_SortingKeys()

setSortingKeys

public void setSortingKeys(Map value)
Sets the value of the 'Sorting Keys' attribute.

The property is an ordered map of sorting string keys to their SortingDirection. The key strings are user-defined and normally used when the Sorting property is set to Automatic The value must be an empty map or one that contains only java.lang.String objects in the keys and com.ibm.xtools.notation.Alignment objects in the values

Parameters:
value - the new value of the 'Sorting Keys' attribute. The value cannot be null
Throws:
NullPointerException - if the passed map is null
IllegalArgumentException - if one or more keys in the passed map is not of type java.lang.String or one or more values is not of type com.ibm.xtools.notation.Alignment
See Also:
getSortingKeys()

getSortedObjects

public org.eclipse.emf.common.util.EList getSortedObjects()
Returns the value of the 'Sorted Objects' reference list. The list contents are of type EObject.

The property is an ordered list of references to objects be sorted. The property is normally used when the Sorting property is set to Manual

Returns:
the value of the 'Sorted Objects' reference list.
See Also:
NotationPackage.getSortingStyle_SortedObjects()

IBM Rational Software Modeler
Release 6.0


Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2004. All rights reserved.