View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one   *
3    * or more contributor license agreements.  See the NOTICE file *
4    * distributed with this work for additional information        *
5    * regarding copyright ownership.  The ASF licenses this file   *
6    * to you under the Apache License, Version 2.0 (the            *
7    * "License"); you may not use this file except in compliance   *
8    * with the License.  You may obtain a copy of the License at   *
9    *                                                              *
10   *   http://www.apache.org/licenses/LICENSE-2.0                 *
11   *                                                              *
12   * Unless required by applicable law or agreed to in writing,   *
13   * software distributed under the License is distributed on an  *
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY       *
15   * KIND, either express or implied.  See the License for the    *
16   * specific language governing permissions and limitations      *
17   * under the License.                                           *
18   */ 
19  package org.apache.rat.analysis.license;
20  
21  import org.apache.rat.analysis.RatHeaderAnalysisException;
22  import org.apache.rat.api.Document;
23  import org.apache.rat.api.MetaData;
24  
25  public class BaseLicense {
26  	private final MetaData.Datum licenseFamilyCategory;
27  	private final MetaData.Datum licenseFamilyName;
28  	private final String notes;
29  	
30  	public BaseLicense(final MetaData.Datum licenseFamilyCategory, final MetaData.Datum licenseFamilyName, final String notes)
31  	{
32  		this.licenseFamilyCategory = licenseFamilyCategory;
33  		this.licenseFamilyName = licenseFamilyName;
34  		this.notes = notes;
35  	}
36      
37      public final void reportOnLicense(Document subject) throws RatHeaderAnalysisException {
38          final MetaData metaData = subject.getMetaData();
39          metaData.set(new MetaData.Datum(MetaData.RAT_URL_HEADER_SAMPLE, notes));
40          metaData.set(new MetaData.Datum(MetaData.RAT_URL_HEADER_CATEGORY,licenseFamilyCategory.getValue()));
41          metaData.set(licenseFamilyCategory);
42          metaData.set(licenseFamilyName);
43      }
44  }