Profile (ArgoUML Javadoc for internal use)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.argouml.uml
Class Profile

java.lang.Object
  org.argouml.uml.Profile

Direct Known Subclasses:: ProfileJava

public abstract class Profile
extends Object

This abstract class captures the configurable behavior of Argo.

Constructor Summary
`Profile()`

Method Summary
`abstract String`	`formatCollection(Iterator iter, Object namespace)` This method produces a string the represents the collection of model elements in the context of the specified namespace.
`abstract String`	`formatElement(Object element, Object namespace)` This method produces a string that represents the specific model element in the context of the specified namespace.
`abstract Object`	`getProfileModel()`
`abstract String`	`getProfileModelFilename()` Return the filename that was or will be used to load the profile/default model.
`abstract void`	`setProfileModelFilename(String filename)` Set the filename to load the profile model from.

Methods inherited from class java.lang.Object

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

Constructor Detail

Profile

public Profile()

Method Detail

formatElement

public abstract String formatElement(Object element,
                                     Object namespace)

This method produces a string that represents the specific model element in the context of the specified namespace.

Parameters:: element - element to represent.; namespace - context namespace (may be null).
Returns:: a string representing the model element

formatCollection

public abstract String formatCollection(Iterator iter,
                                        Object namespace)

This method produces a string the represents the collection of model elements in the context of the specified namespace.

Parameters:: iter - iterator over collection; namespace - context namespace (may be null).
Returns:: a string representing the collection

getProfileModel

public abstract Object getProfileModel()
                                throws ProfileException

Returns:: the UML Model that contains the profile model
Throws:: ProfileException - if failed to get profile.

setProfileModelFilename

public abstract void setProfileModelFilename(String filename)
                                      throws ProfileException

Set the filename to load the profile model from. This will be remembered and used as the file for all future loads.

Parameters:: filename - file name of XMI file containing model to use as profile
Throws:: ProfileException - if the given file isn't a valid profile

getProfileModelFilename

public abstract String getProfileModelFilename()

Return the filename that was or will be used to load the profile/default model.

Returns:: the filename