org.apache.rat.api
Class MetaData

java.lang.Object
  extended by org.apache.rat.api.MetaData

public class MetaData
extends Object

Data about the subject.


Nested Class Summary
static class MetaData.Datum
          A datum.
 
Field Summary
static MetaData.Datum RAT_APPROVED_LICENSE_DATIM_FALSE
           
static MetaData.Datum RAT_APPROVED_LICENSE_DATIM_TRUE
           
static String RAT_APPROVED_LICENSE_VALUE_FALSE
           
static String RAT_APPROVED_LICENSE_VALUE_TRUE
           
static String RAT_BASE_URL
           
static MetaData.Datum RAT_DOCUMENT_CATEGORY_DATUM_ARCHIVE
           
static MetaData.Datum RAT_DOCUMENT_CATEGORY_DATUM_BINARY
           
static MetaData.Datum RAT_DOCUMENT_CATEGORY_DATUM_GENERATED
           
static MetaData.Datum RAT_DOCUMENT_CATEGORY_DATUM_NOTICE
           
static MetaData.Datum RAT_DOCUMENT_CATEGORY_DATUM_STANDARD
           
static MetaData.Datum RAT_DOCUMENT_CATEGORY_DATUM_UNKNOWN
           
static String RAT_DOCUMENT_CATEGORY_VALUE_ARCHIVE
           
static String RAT_DOCUMENT_CATEGORY_VALUE_BINARY
           
static String RAT_DOCUMENT_CATEGORY_VALUE_GENERATED
           
static String RAT_DOCUMENT_CATEGORY_VALUE_NOTICE
           
static String RAT_DOCUMENT_CATEGORY_VALUE_STANDARD
           
static String RAT_DOCUMENT_CATEGORY_VALUE_UNKNOWN
           
static MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_ASL
           
static MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_DOJO
           
static MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_GEN
           
static MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_OASIS
           
static MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_TMF
           
static MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_UNKNOWN
           
static MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_W3C
           
static MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_W3CD
           
static String RAT_LICENSE_FAMILY_CATEGORY_VALUE_ASL
           
static String RAT_LICENSE_FAMILY_CATEGORY_VALUE_DOJO
           
static String RAT_LICENSE_FAMILY_CATEGORY_VALUE_GEN
           
static String RAT_LICENSE_FAMILY_CATEGORY_VALUE_OASIS
           
static String RAT_LICENSE_FAMILY_CATEGORY_VALUE_TMF
           
static String RAT_LICENSE_FAMILY_CATEGORY_VALUE_UNKNOWN
           
static String RAT_LICENSE_FAMILY_CATEGORY_VALUE_W3C
           
static String RAT_LICENSE_FAMILY_CATEGORY_VALUE_W3CD
           
static MetaData.Datum RAT_LICENSE_FAMILY_NAME_DATUM_ACADEMIC_FREE_LICENSE_VERSION_2_1
           
static MetaData.Datum RAT_LICENSE_FAMILY_NAME_DATUM_APACHE_LICENSE_VERSION_2_0
           
static MetaData.Datum RAT_LICENSE_FAMILY_NAME_DATUM_MODIFIED_BSD_LICENSE
           
static MetaData.Datum RAT_LICENSE_FAMILY_NAME_DATUM_OASIS_OPEN_LICENSE
           
static MetaData.Datum RAT_LICENSE_FAMILY_NAME_DATUM_UNKNOWN
           
static MetaData.Datum RAT_LICENSE_FAMILY_NAME_DATUM_W3C_DOCUMENT_COPYRIGHT
           
static MetaData.Datum RAT_LICENSE_FAMILY_NAME_DATUM_W3C_SOFTWARE_COPYRIGHT
           
static String RAT_LICENSE_FAMILY_NAME_VALUE_ACADEMIC_FREE_LICENSE_VERSION_2_1
           
static String RAT_LICENSE_FAMILY_NAME_VALUE_APACHE_LICENSE_VERSION_2_0
           
static String RAT_LICENSE_FAMILY_NAME_VALUE_MODIFIED_BSD_LICENSE
           
static String RAT_LICENSE_FAMILY_NAME_VALUE_OASIS_OPEN_LICENSE
           
static String RAT_LICENSE_FAMILY_NAME_VALUE_UNKNOWN
           
static String RAT_LICENSE_FAMILY_NAME_VALUE_W3C_DOCUMENT_COPYRIGHT
           
static String RAT_LICENSE_FAMILY_NAME_VALUE_W3C_SOFTWARE_COPYRIGHT
           
static String RAT_URL_APPROVED_LICENSE
           
static String RAT_URL_DOCUMENT_CATEGORY
           
static String RAT_URL_HEADER_CATEGORY
           
static String RAT_URL_HEADER_SAMPLE
           
static String RAT_URL_LICENSE_FAMILY_CATEGORY
           
static String RAT_URL_LICENSE_FAMILY_NAME
           
 
Constructor Summary
MetaData()
           
MetaData(ContentType contentType)
           
 
Method Summary
 void add(MetaData.Datum datum)
          Adds a new datum.
 void clear()
          Clears all data.
 boolean clear(String name)
          Removes all data matching the given name.
 MetaData.Datum get(String name)
          Gets the first datum matching the given name.
 ContentType getContentType()
          Gets the content type for the subject.
 Collection getData()
          Gets all data.
 void set(MetaData.Datum datum)
          Puts in a new datum replacing any existing data.
 void setContentType(ContentType contentType)
          Sets the content type for this subject.
 String value(String name)
          Gets the value of the first datum matching the given name.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RAT_BASE_URL

public static final String RAT_BASE_URL
See Also:
Constant Field Values

RAT_URL_DOCUMENT_CATEGORY

public static final String RAT_URL_DOCUMENT_CATEGORY
See Also:
Constant Field Values

RAT_DOCUMENT_CATEGORY_VALUE_GENERATED

public static final String RAT_DOCUMENT_CATEGORY_VALUE_GENERATED
See Also:
Constant Field Values

RAT_DOCUMENT_CATEGORY_VALUE_UNKNOWN

public static final String RAT_DOCUMENT_CATEGORY_VALUE_UNKNOWN
See Also:
Constant Field Values

RAT_DOCUMENT_CATEGORY_VALUE_ARCHIVE

public static final String RAT_DOCUMENT_CATEGORY_VALUE_ARCHIVE
See Also:
Constant Field Values

RAT_DOCUMENT_CATEGORY_VALUE_NOTICE

public static final String RAT_DOCUMENT_CATEGORY_VALUE_NOTICE
See Also:
Constant Field Values

RAT_DOCUMENT_CATEGORY_VALUE_BINARY

public static final String RAT_DOCUMENT_CATEGORY_VALUE_BINARY
See Also:
Constant Field Values

RAT_DOCUMENT_CATEGORY_VALUE_STANDARD

public static final String RAT_DOCUMENT_CATEGORY_VALUE_STANDARD
See Also:
Constant Field Values

RAT_DOCUMENT_CATEGORY_DATUM_GENERATED

public static final MetaData.Datum RAT_DOCUMENT_CATEGORY_DATUM_GENERATED

RAT_DOCUMENT_CATEGORY_DATUM_UNKNOWN

public static final MetaData.Datum RAT_DOCUMENT_CATEGORY_DATUM_UNKNOWN

RAT_DOCUMENT_CATEGORY_DATUM_ARCHIVE

public static final MetaData.Datum RAT_DOCUMENT_CATEGORY_DATUM_ARCHIVE

RAT_DOCUMENT_CATEGORY_DATUM_NOTICE

public static final MetaData.Datum RAT_DOCUMENT_CATEGORY_DATUM_NOTICE

RAT_DOCUMENT_CATEGORY_DATUM_BINARY

public static final MetaData.Datum RAT_DOCUMENT_CATEGORY_DATUM_BINARY

RAT_DOCUMENT_CATEGORY_DATUM_STANDARD

public static final MetaData.Datum RAT_DOCUMENT_CATEGORY_DATUM_STANDARD

RAT_URL_HEADER_CATEGORY

public static final String RAT_URL_HEADER_CATEGORY
See Also:
Constant Field Values

RAT_URL_LICENSE_FAMILY_CATEGORY

public static final String RAT_URL_LICENSE_FAMILY_CATEGORY
See Also:
Constant Field Values

RAT_LICENSE_FAMILY_CATEGORY_VALUE_GEN

public static final String RAT_LICENSE_FAMILY_CATEGORY_VALUE_GEN
See Also:
Constant Field Values

RAT_LICENSE_FAMILY_CATEGORY_VALUE_UNKNOWN

public static final String RAT_LICENSE_FAMILY_CATEGORY_VALUE_UNKNOWN
See Also:
Constant Field Values

RAT_LICENSE_FAMILY_CATEGORY_VALUE_ASL

public static final String RAT_LICENSE_FAMILY_CATEGORY_VALUE_ASL
See Also:
Constant Field Values

RAT_LICENSE_FAMILY_CATEGORY_VALUE_OASIS

public static final String RAT_LICENSE_FAMILY_CATEGORY_VALUE_OASIS
See Also:
Constant Field Values

RAT_LICENSE_FAMILY_CATEGORY_VALUE_W3CD

public static final String RAT_LICENSE_FAMILY_CATEGORY_VALUE_W3CD
See Also:
Constant Field Values

RAT_LICENSE_FAMILY_CATEGORY_VALUE_W3C

public static final String RAT_LICENSE_FAMILY_CATEGORY_VALUE_W3C
See Also:
Constant Field Values

RAT_LICENSE_FAMILY_CATEGORY_VALUE_DOJO

public static final String RAT_LICENSE_FAMILY_CATEGORY_VALUE_DOJO
See Also:
Constant Field Values

RAT_LICENSE_FAMILY_CATEGORY_VALUE_TMF

public static final String RAT_LICENSE_FAMILY_CATEGORY_VALUE_TMF
See Also:
Constant Field Values

RAT_LICENSE_FAMILY_CATEGORY_DATUM_GEN

public static final MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_GEN

RAT_LICENSE_FAMILY_CATEGORY_DATUM_UNKNOWN

public static final MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_UNKNOWN

RAT_LICENSE_FAMILY_CATEGORY_DATUM_ASL

public static final MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_ASL

RAT_LICENSE_FAMILY_CATEGORY_DATUM_OASIS

public static final MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_OASIS

RAT_LICENSE_FAMILY_CATEGORY_DATUM_W3CD

public static final MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_W3CD

RAT_LICENSE_FAMILY_CATEGORY_DATUM_W3C

public static final MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_W3C

RAT_LICENSE_FAMILY_CATEGORY_DATUM_DOJO

public static final MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_DOJO

RAT_LICENSE_FAMILY_CATEGORY_DATUM_TMF

public static final MetaData.Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_TMF

RAT_URL_LICENSE_FAMILY_NAME

public static final String RAT_URL_LICENSE_FAMILY_NAME
See Also:
Constant Field Values

RAT_LICENSE_FAMILY_NAME_VALUE_W3C_SOFTWARE_COPYRIGHT

public static final String RAT_LICENSE_FAMILY_NAME_VALUE_W3C_SOFTWARE_COPYRIGHT
See Also:
Constant Field Values

RAT_LICENSE_FAMILY_NAME_VALUE_W3C_DOCUMENT_COPYRIGHT

public static final String RAT_LICENSE_FAMILY_NAME_VALUE_W3C_DOCUMENT_COPYRIGHT
See Also:
Constant Field Values

RAT_LICENSE_FAMILY_NAME_VALUE_OASIS_OPEN_LICENSE

public static final String RAT_LICENSE_FAMILY_NAME_VALUE_OASIS_OPEN_LICENSE
See Also:
Constant Field Values

RAT_LICENSE_FAMILY_NAME_VALUE_MODIFIED_BSD_LICENSE

public static final String RAT_LICENSE_FAMILY_NAME_VALUE_MODIFIED_BSD_LICENSE
See Also:
Constant Field Values

RAT_LICENSE_FAMILY_NAME_VALUE_APACHE_LICENSE_VERSION_2_0

public static final String RAT_LICENSE_FAMILY_NAME_VALUE_APACHE_LICENSE_VERSION_2_0
See Also:
Constant Field Values

RAT_LICENSE_FAMILY_NAME_VALUE_ACADEMIC_FREE_LICENSE_VERSION_2_1

public static final String RAT_LICENSE_FAMILY_NAME_VALUE_ACADEMIC_FREE_LICENSE_VERSION_2_1
See Also:
Constant Field Values

RAT_LICENSE_FAMILY_NAME_VALUE_UNKNOWN

public static final String RAT_LICENSE_FAMILY_NAME_VALUE_UNKNOWN
See Also:
Constant Field Values

RAT_LICENSE_FAMILY_NAME_DATUM_W3C_SOFTWARE_COPYRIGHT

public static final MetaData.Datum RAT_LICENSE_FAMILY_NAME_DATUM_W3C_SOFTWARE_COPYRIGHT

RAT_LICENSE_FAMILY_NAME_DATUM_W3C_DOCUMENT_COPYRIGHT

public static final MetaData.Datum RAT_LICENSE_FAMILY_NAME_DATUM_W3C_DOCUMENT_COPYRIGHT

RAT_LICENSE_FAMILY_NAME_DATUM_OASIS_OPEN_LICENSE

public static final MetaData.Datum RAT_LICENSE_FAMILY_NAME_DATUM_OASIS_OPEN_LICENSE

RAT_LICENSE_FAMILY_NAME_DATUM_MODIFIED_BSD_LICENSE

public static final MetaData.Datum RAT_LICENSE_FAMILY_NAME_DATUM_MODIFIED_BSD_LICENSE

RAT_LICENSE_FAMILY_NAME_DATUM_APACHE_LICENSE_VERSION_2_0

public static final MetaData.Datum RAT_LICENSE_FAMILY_NAME_DATUM_APACHE_LICENSE_VERSION_2_0

RAT_LICENSE_FAMILY_NAME_DATUM_ACADEMIC_FREE_LICENSE_VERSION_2_1

public static final MetaData.Datum RAT_LICENSE_FAMILY_NAME_DATUM_ACADEMIC_FREE_LICENSE_VERSION_2_1

RAT_LICENSE_FAMILY_NAME_DATUM_UNKNOWN

public static final MetaData.Datum RAT_LICENSE_FAMILY_NAME_DATUM_UNKNOWN

RAT_URL_HEADER_SAMPLE

public static final String RAT_URL_HEADER_SAMPLE
See Also:
Constant Field Values

RAT_URL_APPROVED_LICENSE

public static final String RAT_URL_APPROVED_LICENSE
See Also:
Constant Field Values

RAT_APPROVED_LICENSE_VALUE_TRUE

public static final String RAT_APPROVED_LICENSE_VALUE_TRUE

RAT_APPROVED_LICENSE_VALUE_FALSE

public static final String RAT_APPROVED_LICENSE_VALUE_FALSE

RAT_APPROVED_LICENSE_DATIM_TRUE

public static final MetaData.Datum RAT_APPROVED_LICENSE_DATIM_TRUE

RAT_APPROVED_LICENSE_DATIM_FALSE

public static final MetaData.Datum RAT_APPROVED_LICENSE_DATIM_FALSE
Constructor Detail

MetaData

public MetaData()

MetaData

public MetaData(ContentType contentType)
Method Detail

getContentType

public ContentType getContentType()
Gets the content type for the subject.

Returns:
or null when the type is unknown

setContentType

public void setContentType(ContentType contentType)
Sets the content type for this subject.

Parameters:
contentType - ContentType, or null when the content type is unknown

getData

public Collection getData()
Gets all data.

Returns:
unmodifiable view of the meta data.

add

public void add(MetaData.Datum datum)
Adds a new datum. Existing data with the same name are not replaced.

Parameters:
datum -
See Also:
set(org.apache.rat.api.MetaData.Datum)

set

public void set(MetaData.Datum datum)
Puts in a new datum replacing any existing data. Any current data matching the name are removed.

Parameters:
datum - not null
See Also:
add(org.apache.rat.api.MetaData.Datum)

get

public MetaData.Datum get(String name)
Gets the first datum matching the given name.

Parameters:
name - not null
Returns:
the matching datum first added when there is any matching data, null otherwise

value

public String value(String name)
Gets the value of the first datum matching the given name.

Parameters:
name - not null
Returns:
the value of the matchin datum first added when there is any matching data, null otherwise

clear

public boolean clear(String name)
Removes all data matching the given name.

Parameters:
name - not null
Returns:
true if any data match, false otherwise

clear

public void clear()
Clears all data.



Copyright © 2006-2011 Apache Software Foundation. All Rights Reserved.