org.ucworkbench.model
Interface IFileModel

All Superinterfaces:
IIdentifiable, IRegion, ITextModel, IUCElement
All Known Subinterfaces:
IActor, IUseCase

public interface IFileModel
extends ITextModel, IIdentifiable

It is a base interface for root model objects in files (e.g. use case, actor). Each such file has to contain properties section, provide alias information, and provide content assistant propositions for specified positions in file.


Method Summary
 java.util.Set<java.lang.String> getAliases()
          Returns all aliases of the current file.
 java.util.Set<java.lang.String> getContentAssistantPropositions(int globalOffset)
          Returns all content assistant propositions for specified offset.
 IPropertiesSection getPropertiesSection()
          Returns properties section.
 java.lang.String getPropertyValue(java.lang.String propertyName)
          Returns the value of specified property.
 
Methods inherited from interface org.ucworkbench.model.ITextModel
containsOffset, getAsText, getCorrespondingFileModel, getModelElementByOffset, getParent, getTextModelChildren
 
Methods inherited from interface org.ucworkbench.model.IUCElement
accept, childrenAccept, exists, getAncestor, getChildren, getCorrespondingResource, getElementName, getElementType, getPath, getUCProject, getUnderlyingResource
 
Methods inherited from interface org.ucworkbench.model.supporting.IRegion
getLength, getOffset
 
Methods inherited from interface org.ucworkbench.model.IIdentifiable
getID
 
Methods inherited from interface org.ucworkbench.model.IUCElement
accept, childrenAccept, exists, getAncestor, getChildren, getCorrespondingResource, getElementName, getElementType, getPath, getUCProject, getUnderlyingResource
 

Method Detail

getPropertiesSection

IPropertiesSection getPropertiesSection()
Returns properties section.

Returns:

getPropertyValue

java.lang.String getPropertyValue(java.lang.String propertyName)
Returns the value of specified property.

Parameters:
propertyName -
Returns:
null if property with specified name does not exist

getAliases

java.util.Set<java.lang.String> getAliases()
Returns all aliases of the current file.

Returns:
never returns null

getContentAssistantPropositions

java.util.Set<java.lang.String> getContentAssistantPropositions(int globalOffset)
Returns all content assistant propositions for specified offset.

Parameters:
globalOffset -
Returns:
never returns null