com.mkdoc.schema
Interface Schema

All Superinterfaces:
Resolver
All Known Implementing Classes:
AbstractSchema, DublinCoreElements, DublinCoreTerms, UKeGMS

public interface Schema
extends Resolver

An interface for metadata schema.

XHTML metadata schema are expected to have a prefix to distinguish vocabularies, e.g. "DC" for Dublin Core.

Version:
0.9 2005-06-17
Author:
Philip Shaw

Method Summary
 java.lang.String[] getAllPrefixes()
          Get the HTML metadata prefixes recognised by this schema.
 java.lang.String getDefaultPrefix()
          Get the default namespace prefix for the schema.
 java.lang.String getName()
          Get the common name for the schema.
 SchemaProperty getNamedPredicateProperty(java.lang.String name)
          Get the schema property for a given predicate.
 java.util.Collection getPredicates()
          Get a collection of schema property predicates for this schema.
 java.lang.String getUri()
          Get the base URI for the metadata schema.
 boolean providesQualifiers()
          Signal whether the schema provides element qualifiers.
 boolean providesQualifiersFor(java.lang.String uri)
          Check whether the schema provides qualifiers for a specific schema.
 
Methods inherited from interface com.mkdoc.schema.Resolver
expandPredicate, expandScheme
 

Method Detail

getUri

public java.lang.String getUri()
Get the base URI for the metadata schema.

Returns:
The namespace URI for the metadata schema.
Since:
Version 0.2 2004-12-23

getDefaultPrefix

public java.lang.String getDefaultPrefix()
Get the default namespace prefix for the schema.

Returns:
The default namepace prefix for the schema.
Since:
Version 0.3 2005-03-01

getAllPrefixes

public java.lang.String[] getAllPrefixes()
Get the HTML metadata prefixes recognised by this schema.

Returns:
An array of one or more schema prefixes in mixed case.
Since:
Version 0.6 2005-05-27

providesQualifiers

public boolean providesQualifiers()
Signal whether the schema provides element qualifiers.

Returns:
true if the schema
Since:
Version 0.4 2005-03-10

providesQualifiersFor

public boolean providesQualifiersFor(java.lang.String uri)
Check whether the schema provides qualifiers for a specific schema.

Parameters:
uri - The URI of another schema to check for extensions.
Returns:
true if the schema provieds qualifiers for the schema signified by the URI.
Since:
Version 0.4 2005-03-10

getPredicates

public java.util.Collection getPredicates()
Get a collection of schema property predicates for this schema.

Returns:
A collection of predicate names.
Since:
Version 0.7 2005-06-10

getNamedPredicateProperty

public SchemaProperty getNamedPredicateProperty(java.lang.String name)
Get the schema property for a given predicate.

Parameters:
name - The predicate name without prefix.
Returns:
The schema property for the predicate or null if no mapping exists.
Since:
Version 0.8 2005-06-16

getName

public java.lang.String getName()
Get the common name for the schema.

Returns:
The common name for the schema.
Since:
Version 0.9 2005-06-17