org.archive.crawler.url.canonicalize
Class RegexRule

java.lang.Object
  extended by javax.management.Attribute
      extended by org.archive.crawler.settings.Type
          extended by org.archive.crawler.settings.ComplexType
              extended by org.archive.crawler.settings.ModuleType
                  extended by org.archive.crawler.url.canonicalize.BaseRule
                      extended by org.archive.crawler.url.canonicalize.RegexRule
All Implemented Interfaces:
java.io.Serializable, javax.management.DynamicMBean, CanonicalizationRule

public class RegexRule
extends BaseRule

General conversion rule.

Version:
$Date: 2006-09-25 20:27:35 +0000 (Mon, 25 Sep 2006) $, $Revision: 4655 $
Author:
stack
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class org.archive.crawler.settings.ComplexType
ComplexType.MBeanAttributeInfoIterator
 
Field Summary
protected static java.util.logging.Logger logger
           
 
Fields inherited from class org.archive.crawler.url.canonicalize.BaseRule
ATTR_ENABLED
 
Fields inherited from class org.archive.crawler.settings.ComplexType
definition, definitionMap
 
Constructor Summary
  RegexRule(java.lang.String name)
           
protected RegexRule(java.lang.String name, java.lang.String defaultRegex, java.lang.String defaultFormat)
           
 
Method Summary
 java.lang.String canonicalize(java.lang.String url, java.lang.Object context)
          Apply this canonicalization rule.
protected  void format(java.util.regex.Matcher matcher, java.lang.String format, java.lang.StringBuffer buffer)
           
protected  java.lang.String getNullOrAttribute(java.lang.String name, java.lang.Object context)
           
 
Methods inherited from class org.archive.crawler.url.canonicalize.BaseRule
doStripRegexMatch, isEnabled
 
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, toString, 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, hashCode
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.archive.crawler.url.CanonicalizationRule
getName
 

Field Detail

logger

protected static java.util.logging.Logger logger
Constructor Detail

RegexRule

public RegexRule(java.lang.String name)

RegexRule

protected RegexRule(java.lang.String name,
                    java.lang.String defaultRegex,
                    java.lang.String defaultFormat)
Method Detail

canonicalize

public java.lang.String canonicalize(java.lang.String url,
                                     java.lang.Object context)
Description copied from interface: CanonicalizationRule
Apply this canonicalization rule.

Parameters:
url - Url string we apply this rule to.
context - An object that will provide context for the settings system. The UURI of the URL we're canonicalizing is an example of an object that provides context.
Returns:
Result of applying this rule to passed url.

format

protected void format(java.util.regex.Matcher matcher,
                      java.lang.String format,
                      java.lang.StringBuffer buffer)
Parameters:
matcher - Matched matcher.
format - Output format specifier.
buffer - Buffer to append output to.

getNullOrAttribute

protected java.lang.String getNullOrAttribute(java.lang.String name,
                                              java.lang.Object context)


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