de.uni_paderborn.fujaba.views
Class ViewDefinition

java.lang.Object
  extended byde.uni_paderborn.fujaba.basic.BasicIncrement
      extended byde.uni_paderborn.fujaba.views.ViewDefinition
All Implemented Interfaces:
java.lang.Comparable, UniqueIdentifier

public class ViewDefinition
extends BasicIncrement

A ViewDefinition consists of a Filter and all the information needed to use that filter like source diagram, context, start items.

A number of ViewDefinitions defines a ViewDiagram.

Associations

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

                                    N
 ViewDefinition ----------------------> UMLDiagramItem
                           startItems

                 N                      0..1
 ViewDefinition ----------------------------- ViewDiagram
                 ViewDefinitions     diagram
 

Version:
$Revision: 1.17 $
Author:
$Author: schneider $

Field Summary
private  int context
          No comment provided by developer, please add a comment to improve documentation.
private  ViewDiagram diagram
           N 0..1 ViewDefinition ----------------------------- ViewDiagram ViewDefinitions diagram
private  boolean evaluating
          No comment provided by developer, please add a comment to improve documentation.
private  Filter filter
           N 0..1 ViewDefinition ----------------------------- Filter viewDefinitions filter
private  de.upb.tools.fca.FHashSet items
           N N ViewDefinition ----------------------------- UMLDiagramItem revItems items
private static org.apache.log4j.Logger log
          log4j logging
private  java.lang.String name
          No comment provided by developer, please add a comment to improve documentation.
private  de.upb.tools.fca.FHashSet startItems
           N N ViewDefinition ----------------------------- UMLDiagramItem viewDefinitions startItems
private  boolean update
          No comment provided by developer, please add a comment to improve documentation.
 
Fields inherited from class de.uni_paderborn.fujaba.basic.BasicIncrement
dontUseAccessMethodsInThisClass
 
Constructor Summary
ViewDefinition()
           
 
Method Summary
 boolean addToItems(UMLDiagramItem value)
          Access method for an one to n association.
 boolean addToItems(UMLDiagramItem value, UMLDiagram diag)
          This is needed for parsing XML-files
 boolean addToStartItems(UMLDiagramItem value)
          Access method for an one to n association.
protected  java.util.Set evaluate()
          No comment provided by developer, please add a comment to improve documentation.
 int getContext()
          get the context for the view
private  java.util.Set getContextItems()
           
 ViewDiagram getDiagram()
          Get the diagram attribute of the ViewDefinition object
 Filter getFilter()
          Get the filter attribute of the ViewDefinition object
protected  java.util.Set getItems()
          Get the items attribute of the ViewDefinition object
 java.lang.String getName()
          Get the name attribute of the ViewDefinition object
 boolean hasInItems(UMLDiagramItem value)
          No comment provided by developer, please add a comment to improve documentation.
 boolean hasInStartItems(UMLDiagramItem value)
          No comment provided by developer, please add a comment to improve documentation.
 boolean isUpdate()
           
 java.util.Iterator iteratorOfItems()
          No comment provided by developer, please add a comment to improve documentation.
 java.util.Iterator iteratorOfStartItems()
          No comment provided by developer, please add a comment to improve documentation.
 void removeAllFromItems()
          No comment provided by developer, please add a comment to improve documentation.
 void removeAllFromStartItems()
          No comment provided by developer, please add a comment to improve documentation.
 boolean removeFromItems(UMLDiagramItem value)
          No comment provided by developer, please add a comment to improve documentation.
 boolean removeFromStartItems(UMLDiagramItem value)
          No comment provided by developer, please add a comment to improve documentation.
 void removeYou()
          No comment provided by developer, please add a comment to improve documentation.
 void setContext(int context)
          define the context for the view
 boolean setDiagram(ViewDiagram value)
          Sets the diagram attribute of the ViewDefinition object
 boolean setFilter(Filter value)
          Sets the filter attribute of the ViewDefinition object
 boolean setName(java.lang.String name)
          Sets the name attribute of the ViewDefinition object
 boolean setUpdate(boolean update)
          Specifies whether the ViewDefinition should be automatically updated when the source diagram changes
 int sizeOfItems()
          No comment provided by developer, please add a comment to improve documentation.
 int sizeOfStartItems()
          No comment provided by developer, please add a comment to improve documentation.
 void update()
          update the ViewDefinition.
 
Methods inherited from class de.uni_paderborn.fujaba.basic.BasicIncrement
compareTo, getID, getUniqueID, getUniqueID, isGenerated, lessUniqueId, readAttributes, readAttributes, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, resetClassInfos, resetFieldWriteMethods, setAttribValue, setAttribValue, setGenerated, setID, setUniqueId, writeAttributes, writeClassToStringBuffer, writeClassToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

log

private static final transient org.apache.log4j.Logger log
log4j logging


update

private boolean update
No comment provided by developer, please add a comment to improve documentation.


name

private java.lang.String name
No comment provided by developer, please add a comment to improve documentation.


context

private int context
No comment provided by developer, please add a comment to improve documentation.


startItems

private de.upb.tools.fca.FHashSet startItems
          N                            N
 ViewDefinition ----------------------------- UMLDiagramItem
          viewDefinitions     startItems
 


items

private transient de.upb.tools.fca.FHashSet items
          N                            N
 ViewDefinition ----------------------------- UMLDiagramItem
          revItems     items
 


diagram

private ViewDiagram diagram
                 N                      0..1
 ViewDefinition ----------------------------- ViewDiagram
                 ViewDefinitions     diagram
 


filter

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


evaluating

private transient boolean evaluating
No comment provided by developer, please add a comment to improve documentation.

Constructor Detail

ViewDefinition

public ViewDefinition()
Method Detail

setUpdate

public boolean setUpdate(boolean update)
Specifies whether the ViewDefinition should be automatically updated when the source diagram changes

Parameters:
update - do update or not
Returns:
true if the value was changed
See Also:
isUpdate()

setName

public boolean setName(java.lang.String name)
Sets the name attribute of the ViewDefinition object

Parameters:
name - The new name value
Returns:
No description provided

getName

public java.lang.String getName()
Get the name attribute of the ViewDefinition object

Returns:
The name value

isUpdate

public boolean isUpdate()
Returns:
true if the update property is set
See Also:
setUpdate(boolean)

setContext

public void setContext(int context)
define the context for the view

Parameters:
context - the context
See Also:
getContext()

getContext

public int getContext()
get the context for the view

Returns:
the context
See Also:
getContext()

addToStartItems

public boolean addToStartItems(UMLDiagramItem value)
Access method for an one to n association.

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

hasInStartItems

public boolean hasInStartItems(UMLDiagramItem value)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
value - No description provided
Returns:
No description provided

iteratorOfStartItems

public java.util.Iterator iteratorOfStartItems()
No comment provided by developer, please add a comment to improve documentation.

Returns:
No description provided

sizeOfStartItems

public int sizeOfStartItems()
No comment provided by developer, please add a comment to improve documentation.

Returns:
No description provided

removeFromStartItems

public boolean removeFromStartItems(UMLDiagramItem value)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
value - No description provided
Returns:
No description provided

removeAllFromStartItems

public void removeAllFromStartItems()
No comment provided by developer, please add a comment to improve documentation.


addToItems

public boolean addToItems(UMLDiagramItem value)
Access method for an one to n association.

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

addToItems

public boolean addToItems(UMLDiagramItem value,
                          UMLDiagram diag)
This is needed for parsing XML-files

Parameters:
value - The object added.
diag - The object added.
Returns:
No description provided

hasInItems

public boolean hasInItems(UMLDiagramItem value)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
value - No description provided
Returns:
No description provided

iteratorOfItems

public java.util.Iterator iteratorOfItems()
No comment provided by developer, please add a comment to improve documentation.

Returns:
No description provided

sizeOfItems

public int sizeOfItems()
No comment provided by developer, please add a comment to improve documentation.

Returns:
No description provided

removeFromItems

public boolean removeFromItems(UMLDiagramItem value)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
value - No description provided
Returns:
No description provided

removeAllFromItems

public void removeAllFromItems()
No comment provided by developer, please add a comment to improve documentation.


getItems

protected java.util.Set getItems()
Get the items attribute of the ViewDefinition object

Returns:
The items value

setDiagram

public boolean setDiagram(ViewDiagram value)
Sets the diagram attribute of the ViewDefinition object

Parameters:
value - The new diagram value
Returns:
No description provided

getDiagram

public ViewDiagram getDiagram()
Get the diagram attribute of the ViewDefinition object

Returns:
The diagram value

setFilter

public boolean setFilter(Filter value)
Sets the filter attribute of the ViewDefinition object

Parameters:
value - The new filter value
Returns:
No description provided

getFilter

public Filter getFilter()
Get the filter attribute of the ViewDefinition object

Returns:
The filter value

getContextItems

private java.util.Set getContextItems()
Returns:
the DiagramItems for the current context

evaluate

protected java.util.Set evaluate()
No comment provided by developer, please add a comment to improve documentation.

Returns:
No description provided

update

public void update()
update the ViewDefinition.

Recalculates the context if the source diagram changed


removeYou

public void removeYou()
No comment provided by developer, please add a comment to improve documentation.

Overrides:
removeYou in class BasicIncrement