oracle.jdeveloper.history

Class HistoryProvider

java.lang.Object

oracle.jdeveloper.history.HistoryProvider

public abstract class HistoryProvider
extends java.lang.Object

An object that can provide a history for a given URL. HistoryProviders should be registered with the HistoryManager.

Since:

10.0.3

Constructor Summary

Constructors

Constructor and Description
HistoryProvider()

Method Summary

Methods

Modifier and Type	Method and Description
abstract HistoryEntry[]	getEntries(java.net.URL url, HistoryFilter filter) Get history entries for the specified URL.
java.lang.String	getIdentifer() Get a history identifier.
HistoryFilter[]	getPredefinedFilters() Get predefined filters for this provider.
abstract HistoryProperty[]	getProperties() Get the history properties available for entries supplied by this provider.
abstract HistoryFilter	getTypeFilter() Get a history filter for entries provided by this type.
abstract boolean	isProviderFor(java.net.URL url) Get whether this provider handles the specified URL.
void	setIdentifier(java.lang.String id)

Methods inherited from class java.lang.Object

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

Constructor Detail

HistoryProvider

public HistoryProvider()

Method Detail

getIdentifer

public java.lang.String getIdentifer()

Get a history identifier.

Returns:

identifier

setIdentifier

public void setIdentifier(java.lang.String id)

getTypeFilter

public abstract HistoryFilter getTypeFilter()

Get a history filter for entries provided by this type.

Returns:

a HistoryFilter that should only accept history entries that were provided by this provider.

getPredefinedFilters

public HistoryFilter[] getPredefinedFilters()

Get predefined filters for this provider. These are presented to the user in a choosable list.

Returns:

an array of predefined filters that the user can select. This is optional; you can return an empty array or null. The default implementation returns null.

getProperties

public abstract HistoryProperty[] getProperties()

Get the history properties available for entries supplied by this provider.

Returns:

get properties.

isProviderFor

public abstract boolean isProviderFor(java.net.URL url)

Get whether this provider handles the specified URL. This may be used when the history viewer needs to know whether providers handle a URL without retrieving all the entries.

Parameters:

url - a URL

Returns:

true if this provider can get the history of the specified URL.

getEntries

public abstract HistoryEntry[] getEntries(java.net.URL url,
                        HistoryFilter filter)

Get history entries for the specified URL.

Parameters:

url - a URL to get the history for.

filter - a filter to use. This may be null. Providers can optionally use this filter to do some preprocessing before querying history entries for efficiency. It's perfectly acceptable to just ignore the filter: all entries returned by this method will be post filtered by the HistoryManager.

Returns:

an array of history entries, can be null if there are none or this provider doesn't handle the specified URL.