ViewerFilter. This method is only valid for
* viewer filters.
*/
public ViewerFilter createViewerFilter() {
if (!isCustomFilter())
return null;
final ViewerFilter[] result = new ViewerFilter[1];
String message = FilterMessages.getFormattedString(
"FilterDescriptor.filterCreationError.message", getId()); //$NON-NLS-1$
ISafeRunnable code = new SafeRunnable(message) {
/*
* @see org.eclipse.core.runtime.ISafeRunnable#run()
*/
public void run() throws Exception {
result[0] = (ViewerFilter) fElement
.createExecutableExtension(CLASS_ATTRIBUTE);
}
};
SafeRunner.run(code);
return result[0];
}
// ---- XML Attribute accessors
// ---------------------------------------------
/**
* Returns the filter's id.
* * This attribute is mandatory for custom filters. The ID for pattern * filters is PATTERN_FILTER_ID_PREFIX plus the pattern itself. *
*/ public String getId() { if (isPatternFilter()) { String targetId = getTargetId(); if (targetId == null) return PATTERN_FILTER_ID_PREFIX + getPattern(); else return targetId + PATTERN_FILTER_ID_PREFIX + getPattern(); } else return fElement.getAttribute(ID_ATTRIBUTE); } /** * Returns the filter's name. ** If the name of a pattern filter is missing then the pattern is used as * its name. *
*/ public String getName() { String name = fElement.getAttribute(NAME_ATTRIBUTE); if (name == null && isPatternFilter()) name = getPattern(); return name; } /** * Returns the filter's pattern. * * @return the pattern string ornull if it's not a pattern
* filter
*/
public String getPattern() {
return fElement.getAttribute(PATTERN_ATTRIBUTE);
}
/**
* Returns the filter's viewId.
*
* @return the view ID or null if the filter is for all views
* @since 3.0
*/
public String getTargetId() {
String tid = fElement.getAttribute(TARGET_ID_ATTRIBUTE);
if (tid != null)
return tid;
// Backwards compatibility code
return fElement.getAttribute(VIEW_ID_ATTRIBUTE);
}
/**
* Returns the filter's description.
*
* @return the description or null if no description is
* provided
*/
public String getDescription() {
String description = fElement.getAttribute(DESCRIPTION_ATTRIBUTE);
if (description == null)
description = ""; //$NON-NLS-1$
return description;
}
/**
* @return true if this filter is a custom filter.
*/
public boolean isPatternFilter() {
return getPattern() != null;
}
/**
* @return true if this filter is a pattern filter.
*/
public boolean isCustomFilter() {
return fElement.getAttribute(CLASS_ATTRIBUTE) != null;
}
/**
* Returns true if the filter is initially enabled.
*
* This attribute is optional and defaults to true.
*/
public boolean isEnabled() {
String strVal = fElement.getAttribute(ENABLED_ATTRIBUTE);
if (strVal == null)
// backward compatibility
strVal = fElement.getAttribute(SELECTED_ATTRIBUTE);
return strVal == null || Boolean.valueOf(strVal).booleanValue();
}
/*
* Implements a method from IComparable
*/
public int compareTo(Object o) {
if (o instanceof FilterDescriptor)
return Collator.getInstance().compare(getName(),
((FilterDescriptor) o).getName());
else
return Integer.MIN_VALUE;
}
// ---- initialization ---------------------------------------------------
/**
* Creates the filter descriptors.
*/
private static FilterDescriptor[] createFilterDescriptors(
IConfigurationElement[] elements) {
List result = new ArrayList(5);
Set descIds = new HashSet(5);
for (int i = 0; i < elements.length; i++) {
final IConfigurationElement element = elements[i];
if (FILTER_TAG.equals(element.getName())) {
final FilterDescriptor[] desc = new FilterDescriptor[1];
SafeRunner
.run(new SafeRunnable(
FilterMessages
.getString("FilterDescriptor.filterDescriptionCreationError.message")) { //$NON-NLS-1$
public void run() throws Exception {
desc[0] = new FilterDescriptor(element);
}
});
if (desc[0] != null && !descIds.contains(desc[0].getId())) {
result.add(desc[0]);
descIds.add(desc[0].getId());
}
}
}
Collections.sort(result);
return (FilterDescriptor[]) result.toArray(new FilterDescriptor[result
.size()]);
}
public String getLocalId() {
return fElement.getAttribute(ID_ATTRIBUTE);
}
public String getPluginId() {
return fElement.getDeclaringExtension().getNamespace();
}
}