|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectmetricsOverlay.model.MetricDocument
public class MetricDocument
A metric document is a set of metric sets and there mappings, with a path that indicates the document they relate to. A metric document also includes a time stamp so its validity can be confirmed.
Constructor Summary | |
---|---|
MetricDocument(org.eclipse.core.runtime.IPath fileName)
Main constructor. |
|
MetricDocument(java.lang.String fileName)
Alternate constructor |
Method Summary | |
---|---|
void |
addAugmentation(Augmentation augmentation)
|
void |
addMapping(Mapping mapping)
|
void |
addMetric(Metric met)
|
int |
compareTo(MetricDocument o)
|
void |
disableAllMappings()
|
void |
enableAllMappings()
|
java.util.Set<Augmentation> |
getAllAugmentations()
|
java.util.Set<Mapping> |
getAllMappings()
|
java.util.Set<Metric> |
getAllMetrics()
|
Augmentation |
getAugmentation(java.lang.String displayName)
|
org.eclipse.core.runtime.IPath |
getFileName()
|
Mapping |
getMapping(java.lang.String mappingName)
|
Metric |
getMetric(java.lang.String metricName)
|
java.sql.Timestamp |
getTimeStamp()
|
boolean |
isAugmentationNameUnique(java.lang.String name)
|
boolean |
isMappingNameUnique(java.lang.String name)
|
boolean |
isMetricNameUnique(java.lang.String name)
|
int |
numActiveMappings()
|
int |
numDeclaredMappings()
|
int |
numDisplays()
|
int |
numMappings()
Counts the number of mappings that are not stubs. |
int |
numMetrics()
|
void |
removeAugmentation(java.lang.String name)
|
void |
removeMapping(java.lang.String name)
|
void |
removeMetric(java.lang.String name)
|
void |
setAllMappingState(MappingState mState)
|
void |
setFileName(org.eclipse.core.runtime.IPath fileName)
Sets the file name to a specific path |
void |
setFileNameFromString(java.lang.String fileName)
Sets the new file name from a given string. |
void |
setTimeStamp(long timeInMillis)
Sets the time stamp on this document to a particular system time |
void |
setTimeStamp(java.sql.Timestamp ts)
Sets the time stamp on this document to a specific time. |
java.lang.String |
toString()
Overriden toString method. |
void |
updateTimeStamp()
Update the time stamp on this document to the current time. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public MetricDocument(org.eclipse.core.runtime.IPath fileName)
fileName
- initialise the document with a specific path.public MetricDocument(java.lang.String fileName)
fileName
- initialise the document with a string based path. This path
needs to be in a standard path format.Method Detail |
---|
public void updateTimeStamp()
public void setTimeStamp(java.sql.Timestamp ts)
ts
- the time stamp to be setpublic void setTimeStamp(long timeInMillis)
timeInMillis
- standard time in millispublic java.sql.Timestamp getTimeStamp()
public org.eclipse.core.runtime.IPath getFileName()
public void setFileName(org.eclipse.core.runtime.IPath fileName)
fileName
- the new pathpublic void setFileNameFromString(java.lang.String fileName)
fileName
- the new String in a path formatpublic int numMappings()
public int numMetrics()
public int numDisplays()
public int numDeclaredMappings()
public int numActiveMappings()
public java.util.Set<Mapping> getAllMappings()
public java.util.Set<Metric> getAllMetrics()
public java.util.Set<Augmentation> getAllAugmentations()
public java.lang.String toString()
toString
in class java.lang.Object
public void disableAllMappings()
public void enableAllMappings()
public Mapping getMapping(java.lang.String mappingName)
public Metric getMetric(java.lang.String metricName)
public Augmentation getAugmentation(java.lang.String displayName)
public void addMapping(Mapping mapping)
public void addMetric(Metric met)
public void addAugmentation(Augmentation augmentation)
public boolean isMappingNameUnique(java.lang.String name)
public boolean isAugmentationNameUnique(java.lang.String name)
public boolean isMetricNameUnique(java.lang.String name)
public int compareTo(MetricDocument o)
compareTo
in interface java.lang.Comparable<MetricDocument>
public void setAllMappingState(MappingState mState)
public void removeAugmentation(java.lang.String name)
public void removeMapping(java.lang.String name)
public void removeMetric(java.lang.String name)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |