de.uni_paderborn.fujaba.views
Interface Filter

All Known Subinterfaces:
ConfigurableFilter
All Known Implementing Classes:
AbstractConfigurableFilter, AbstractFilter

public interface Filter

A Filter defines a rule for building n-Contexts on UMLDiagrams

Associations

          0..1                            N
 Filter ----------------------------- ViewDefinition
          filter     viewDefinitions
 

Version:
$Revision: 1.10 $
Author:
$Author: schneider $
See Also:
ViewDefinition, ViewDiagram, UMLDiagram, UMLDiagramItem

Method Summary
 boolean addToViewDefinitions(ViewDefinition value)
           0..1 N Filter ----------------------------- ViewDefinition filter viewDefinitions access Method for the above associaction
 java.util.Set get1Context(UMLDiagram diag, java.util.Iterator items)
          Get the 1-Context for the items in the Iterator
 java.util.Set get1Context(UMLDiagram diag, UMLDiagramItem item)
          Get the 1-Context for the given item
 java.lang.String getDescription()
          gives a short description of the Filter
 java.lang.String getName()
          The Name of the Filter.
 java.util.Set getNContext(UMLDiagram diag, java.util.Iterator items, int depth)
          Get the n-Context for the items in the Iterator
 java.util.Set getNContext(UMLDiagram diag, UMLDiagramItem item, int depth)
          Get the n-Context for the items in the Iterator
 java.util.Set grow1Context(UMLDiagram diag, UMLDiagramItem item, ItemSet context)
          In this Method the Rule for the 1-Context is defined.
 boolean hasInViewDefinitions(ViewDefinition value)
           0..1 N Filter ----------------------------- ViewDefinition filter viewDefinitions access Method for the above associaction
 boolean isForDiagram(UMLDiagram diag)
          Defines if this Filter is suited for a diagram or not.
 java.util.Iterator iteratorOfViewDefinitions()
           0..1 N Filter ----------------------------- ViewDefinition filter viewDefinitions access Method for the above associaction
 void removeAllFromViewDefinitions()
           0..1 N Filter ----------------------------- ViewDefinition filter viewDefinitions access Method for the above associaction
 boolean removeFromViewDefinitions(ViewDefinition value)
           0..1 N Filter ----------------------------- ViewDefinition filter viewDefinitions access Method for the above associaction
 int sizeOfViewDefinitions()
           0..1 N Filter ----------------------------- ViewDefinition filter viewDefinitions access Method for the above associaction
 

Method Detail

isForDiagram

public boolean isForDiagram(UMLDiagram diag)
Defines if this Filter is suited for a diagram or not.

Parameters:
diag - the diagram
Returns:
true if this Filter can be used for diag, false otherwise

getName

public java.lang.String getName()
The Name of the Filter. Used for identification in the FilterManager and dialogs. Default is the class name

Returns:
the name of the Filter
See Also:
FilterManager

grow1Context

public java.util.Set grow1Context(UMLDiagram diag,
                                  UMLDiagramItem item,
                                  ItemSet context)
In this Method the Rule for the 1-Context is defined. Each call to this Method increases the Context by one.

Parameters:
diag - The diagram in which the items have to be
item - The item on which the 1-Context is to be built
context - The existing context
Returns:
The new items which can be start points for more growing
See Also:
get1Context(de.uni_paderborn.fujaba.uml.UMLDiagram,de.uni_paderborn.fujaba.uml.UMLDiagramItem), get1Context(de.uni_paderborn.fujaba.uml.UMLDiagram,java.util.Iterator), getNContext(de.uni_paderborn.fujaba.uml.UMLDiagram,de.uni_paderborn.fujaba.uml.UMLDiagramItem,int), getNContext(de.uni_paderborn.fujaba.uml.UMLDiagram,java.util.Iterator,int)

get1Context

public java.util.Set get1Context(UMLDiagram diag,
                                 UMLDiagramItem item)
Get the 1-Context for the given item

Parameters:
diag - The diagram in which the items have to be
item - The item on which the 1-Context is to be built
Returns:
The 1-Context as Set
See Also:
grow1Context(de.uni_paderborn.fujaba.uml.UMLDiagram,de.uni_paderborn.fujaba.uml.UMLDiagramItem,ItemSet), get1Context(de.uni_paderborn.fujaba.uml.UMLDiagram,java.util.Iterator), getNContext(de.uni_paderborn.fujaba.uml.UMLDiagram,de.uni_paderborn.fujaba.uml.UMLDiagramItem,int), getNContext(de.uni_paderborn.fujaba.uml.UMLDiagram,java.util.Iterator,int)

get1Context

public java.util.Set get1Context(UMLDiagram diag,
                                 java.util.Iterator items)
Get the 1-Context for the items in the Iterator

Parameters:
diag - The diagram in which the items have to be
items - Iterator listing the items on which the 1-Context is to be built
Returns:
The 1-Context as Set
See Also:
grow1Context(de.uni_paderborn.fujaba.uml.UMLDiagram,de.uni_paderborn.fujaba.uml.UMLDiagramItem,ItemSet), get1Context(de.uni_paderborn.fujaba.uml.UMLDiagram,de.uni_paderborn.fujaba.uml.UMLDiagramItem), getNContext(de.uni_paderborn.fujaba.uml.UMLDiagram,de.uni_paderborn.fujaba.uml.UMLDiagramItem,int), getNContext(de.uni_paderborn.fujaba.uml.UMLDiagram,java.util.Iterator,int)

getNContext

public java.util.Set getNContext(UMLDiagram diag,
                                 UMLDiagramItem item,
                                 int depth)
Get the n-Context for the items in the Iterator

Parameters:
diag - The diagram in which the items have to be
depth - the context to build
item - No description provided
Returns:
The context as Set
See Also:
grow1Context(de.uni_paderborn.fujaba.uml.UMLDiagram,de.uni_paderborn.fujaba.uml.UMLDiagramItem,ItemSet), get1Context(de.uni_paderborn.fujaba.uml.UMLDiagram,de.uni_paderborn.fujaba.uml.UMLDiagramItem), get1Context(de.uni_paderborn.fujaba.uml.UMLDiagram,java.util.Iterator), getNContext(de.uni_paderborn.fujaba.uml.UMLDiagram,java.util.Iterator,int)

getNContext

public java.util.Set getNContext(UMLDiagram diag,
                                 java.util.Iterator items,
                                 int depth)
Get the n-Context for the items in the Iterator

Parameters:
diag - The diagram in which the items have to be
items - Iterator listing the items on which the 1-Context is to be built
depth - the Context to build
Returns:
The context as Set
See Also:
grow1Context(de.uni_paderborn.fujaba.uml.UMLDiagram,de.uni_paderborn.fujaba.uml.UMLDiagramItem,ItemSet), get1Context(de.uni_paderborn.fujaba.uml.UMLDiagram,de.uni_paderborn.fujaba.uml.UMLDiagramItem), get1Context(de.uni_paderborn.fujaba.uml.UMLDiagram,java.util.Iterator), getNContext(de.uni_paderborn.fujaba.uml.UMLDiagram,de.uni_paderborn.fujaba.uml.UMLDiagramItem,int)

getDescription

public java.lang.String getDescription()
gives a short description of the Filter

Returns:
description text for the filter

addToViewDefinitions

public boolean addToViewDefinitions(ViewDefinition value)
          0..1                            N
 Filter ----------------------------- ViewDefinition
          filter     viewDefinitions
 
access Method for the above associaction

Parameters:
value - The object added.
Returns:
No description provided
See Also:
ViewDefinition

hasInViewDefinitions

public boolean hasInViewDefinitions(ViewDefinition value)
          0..1                            N
 Filter ----------------------------- ViewDefinition
          filter     viewDefinitions
 
access Method for the above associaction

Parameters:
value - No description provided
Returns:
No description provided
See Also:
ViewDefinition

iteratorOfViewDefinitions

public java.util.Iterator iteratorOfViewDefinitions()
          0..1                            N
 Filter ----------------------------- ViewDefinition
          filter     viewDefinitions
 
access Method for the above associaction

Returns:
No description provided
See Also:
ViewDefinition

sizeOfViewDefinitions

public int sizeOfViewDefinitions()
          0..1                            N
 Filter ----------------------------- ViewDefinition
          filter     viewDefinitions
 
access Method for the above associaction

Returns:
No description provided
See Also:
ViewDefinition

removeFromViewDefinitions

public boolean removeFromViewDefinitions(ViewDefinition value)
          0..1                            N
 Filter ----------------------------- ViewDefinition
          filter     viewDefinitions
 
access Method for the above associaction

Parameters:
value - No description provided
Returns:
No description provided
See Also:
ViewDefinition

removeAllFromViewDefinitions

public void removeAllFromViewDefinitions()
          0..1                            N
 Filter ----------------------------- ViewDefinition
          filter     viewDefinitions
 
access Method for the above associaction

See Also:
ViewDefinition