src/dochelper/URLRecordSet.java

Go to the documentation of this file.

/*
 * URLRecordSet.java
 *
 * Created on April 3, 2009, 10:22 AM
 *
 * To change this template, choose Tools | Template Manager
 * and open the template in the editor.
 */

package dochelper;

import dochelper.exceptions.IllegalParamterTypeException;
import dochelper.exceptions.InitializationException;
import dochelper.exceptions.InvalidValueException;
import dochelper.exceptions.MissingArgumentException;
import dochelper.exceptions.ResourceUnavailableException;
import java.util.ArrayList;
import java.util.HashMap;

import java.util.regex.Pattern;
import java.util.regex.Matcher;
import java.util.regex.PatternSyntaxException;

import java.net.URI;

public class URLRecordSet implements RecordSet {

    public static final String ROOT_URL = "rooturl";
            
    public static final String DEPTH = "depth";
    
    protected HashMap<String, Object> params = new HashMap<String, Object>();
    
    protected ArrayList<Record> rsfiles;
        
    protected String name;   
    
    protected int recordSetDepth;

    protected Pattern links = Pattern.compile("a href=\"([.]+)\"");

    
    //The patterns that should be matched to the records for this record set
    private ArrayList<DocPattern> patterns;

    public void setParam(String paramName, Object value) throws IllegalParamterTypeException {

        if (value instanceof String || value instanceof DocumentSection)
            params.put(paramName, value);
        else
            throw new IllegalParamterTypeException(paramName);
    }    
    
    public void checkParams() throws InvalidValueException, MissingArgumentException, ResourceUnavailableException {

        //Validate the path is set
        if (!params.containsKey(ROOT_URL))
            throw new MissingArgumentException(ROOT_URL);

        //Find proper regular expression to validate uri
        //String urlReg = "((https?)://[-\\w]+(\\.\\w[-\\w]*)+|(?i: [a-z0-9] (?:[-a-z0-9]*[a-z0-9])? \\. )+(?-i: com\\b| edu\\b| biz\\b| gov\\b| in(?:t|fo)\\b| mil\\b| net\\b| org\\b| [a-z][a-z]\\.[a-z][a-z]\\b))( : \\d+ )?(/[^.!,?;\"\\'<>()\\[\\]\\{\\}\\s\\x7F-\\xFF]*([.!,?]+ [^.!,?;\"\\'<>()\\[\\]\\{\\}\\s\\x7F-\\xFF]+)*)?";       
        
        String url = (String)params.get(ROOT_URL);
                
        //if(!url.matches(urlReg))
        //    throw new InvalidValueException();        
        
        //Validate the glob is set
        if (!params.containsKey(DEPTH))
            throw new MissingArgumentException(DEPTH);

    }    
    
    public void init() throws InitializationException, ResourceUnavailableException {
        
        //Set class level variables
        recordSetDepth = Integer.parseInt((String)params.get(DEPTH));  

        //Create the records array
        rsfiles = new ArrayList<Record>();

        //Init the record arraylist
        fetchRecords(0, (String)params.get(ROOT_URL));

    }    
    
    private void fetchRecords(int depth, String rootURL) {
        
        depth++;
        
        //return if too deep
        if(depth >recordSetDepth)
          return;
        
        //create a record from this URI
        URLRecord record = null;
        
        //TODO: replace "URLRec" name
        try {
          record = new URLRecord(rootURL, "URLRec");
        }
        catch(InvalidValueException ive) {
          //TODO log invalid URL
        }
        
        //check if this record is in the files fi not add
        if(!rsfiles.contains(record))
          rsfiles.add(record);
        
        //get a list of links
        Matcher match = links.matcher(record.getValue());
        
        while(match.find()) {
          //call this method for each link
          fetchRecords(depth, match.group(1));
        }
    }
    
    public ResultNode execute(ResultNode doc) throws ResourceUnavailableException {

        //Make the RecordSet Node
        ResultNode result = new ResultNode(null, params, this.getName());
        
        //Loop through all the records for this record set
        for (Record record : rsfiles) {
            //add the subtree created by executing this record
            result.addChild(record.execute(patterns));
        }

        doc.addChild(result);

        return doc;
    }
    
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }    
    
    public void addPattern(DocPattern pattern) {

        if (this.patterns == null)
            this.patterns = new ArrayList<DocPattern>();

        this.patterns.add(pattern);
    }

    public void clearPatterns() {
        this.patterns = new ArrayList<DocPattern>();
    }


    public String toString() {

        String out = "";
        //Show the files
        out += "Files Count : " + rsfiles.size();

        //show the patterns
        return out;
    }    
    
}

---