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.archive.crawler.filter
Class URIRegExpFilter

    java.lang.Object
      javax.management.Attribute
          org.archive.crawler.settings.Type
              org.archive.crawler.settings.ComplexType
                  org.archive.crawler.settings.ModuleType
                      org.archive.crawler.framework.Filter
                          org.archive.crawler.filter.URIRegExpFilter

All Implemented Interfaces:
  java.io.Serializable, javax.management.DynamicMBean

Direct Known Subclasses:
  ContentTypeRegExpFilter, FilePatternFilter, PathologicalPathFilter

Deprecated. As of release 1.10.0. Replaced by `DecidingFilter` and equivalent `DecideRule`.

    public class URIRegExpFilter

extends Filter

Compares passed object -- a CrawlURI, UURI, or String -- against a regular expression, accepting matches.

Author:
  Gordon Mohr
See Also:
  Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.archive.crawler.settings.ComplexType
`ComplexType.MBeanAttributeInfoIterator`

Field Summary
`static java.lang.String` | `ATTR_MATCH_RETURN_VALUE` Deprecated.
`static java.lang.String` | `ATTR_REGEXP` Deprecated.

Fields inherited from class org.archive.crawler.framework.Filter
`ATTR_ENABLED`

Fields inherited from class org.archive.crawler.settings.ComplexType
`definition, definitionMap`

Constructor Summary
`` | `URIRegExpFilter(java.lang.String name)` Deprecated.
`` | `URIRegExpFilter(java.lang.String name, java.lang.String regexp)` Deprecated.
`protected` | `URIRegExpFilter(java.lang.String name, java.lang.String description, java.lang.String regexp)` Deprecated.

Method Summary
`protected java.lang.String` | `getRegexp(java.lang.Object o)` Deprecated. Get the regular expression string to match the URI against.
`protected boolean` | `innerAccepts(java.lang.Object o)` Deprecated. Classes subclassing this one should override this method to perfrom their custom determination of whether or not the object given to it.
`protected boolean` | `returnTrueIfMatches(CrawlURI curi)` Deprecated. Checks to see if filter functionality should be inverted for this curi.

Methods inherited from class org.archive.crawler.framework.Filter
`accepts, getFilterOffPosition, kickUpdate, toString`

Methods inherited from class org.archive.crawler.settings.ModuleType
`addElement, listUsedFiles`

Methods inherited from class org.archive.crawler.settings.ComplexType
`addElementToDefinition, checkValue, earlyInitialize, getAbsoluteName, getAttribute, getAttribute, getAttribute, getAttributeInfo, getAttributeInfo, getAttributeInfoIterator, getAttributes, getDataContainerRecursive, getDataContainerRecursive, getDefaultValue, getDescription, getElementFromDefinition, getLegalValues, getLocalAttribute, getMBeanInfo, getMBeanInfo, getParent, getPreservedFields, getSettingsHandler, getUncheckedAttribute, getValue, globalSettings, invoke, isInitialized, isOverridden, iterator, removeElementFromDefinition, setAsOrder, setAttribute, setAttribute, setAttributes, setDescription, setPreservedFields, unsetAttribute`

Methods inherited from class org.archive.crawler.settings.Type
`addConstraint, equals, getConstraints, getLegalValueType, isExpertSetting, isOverrideable, isTransient, setExpertSetting, setLegalValueType, setOverrideable, setTransient`

Methods inherited from class javax.management.Attribute
`getName`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

### ATTR_REGEXP

    public static final java.lang.String ATTR_REGEXP

  Deprecated.
  See Also:
    Constant Field Values

### ATTR_MATCH_RETURN_VALUE

    public static final java.lang.String ATTR_MATCH_RETURN_VALUE

  Deprecated.
  See Also:
    Constant Field Values

Constructor Detail

### URIRegExpFilter

    public URIRegExpFilter(java.lang.String name)

  Deprecated.
  Parameters:
    `name` - Filter name.

### URIRegExpFilter

    public URIRegExpFilter(java.lang.String name,
                           java.lang.String regexp)

  Deprecated.

### URIRegExpFilter

    protected URIRegExpFilter(java.lang.String name,
                              java.lang.String description,
                              java.lang.String regexp)

  Deprecated.

Method Detail

### innerAccepts

    protected boolean innerAccepts(java.lang.Object o)

  Deprecated.
  Description copied from class: `Filter`
  Classes subclassing this one should override this method to perfrom their custom determination of whether or not the object given to it.

  Overrides:
    `innerAccepts` in class `Filter`
  Parameters:
    `o` - The object
  Returns:
    True if it passes the filter.

### getRegexp

    protected java.lang.String getRegexp(java.lang.Object o)

  Deprecated.
  Get the regular expression string to match the URI against.

  Parameters:
    `o` - the object for which the regular expression should be matched against.
  Returns:
    the regular expression to match against.

### returnTrueIfMatches

    protected boolean returnTrueIfMatches(CrawlURI curi)

  Deprecated.
  Description copied from class: `Filter`
  Checks to see if filter functionality should be inverted for this curi.

  All filters will by default return true if curi is accepted by the filter. If this method returns false, then the filter will return true if doesn't match.

  Classes extending this class should override this method with appropriate code.

  Overrides:
    `returnTrueIfMatches` in class `Filter`
  Parameters:
    `curi` - Current CrawlURI
  Returns:
    true for default behaviour, false otherwise.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2003-2008 Internet Archive. All Rights Reserved.