org.hccp.atom
Class Link
java.lang.Object
|
+--org.hccp.atom.Link
- public class Link
- extends java.lang.Object
4.2.7 The "atom:link" Element
The "atom:link" element defines a reference from an entry or feed to
a Web resource. This specification assigns no meaning to the content
(if any) of this element.
atomLink =
element atom:link {
atomCommonAttributes,
attribute href { href },
attribute rel { atomNCName | href }?,
attribute type { atomMediaType }?,
attribute hreflang { atomLanguageTag }?,
attribute title { text }?,
attribute length { text }?,
undefinedContent
}
4.2.7.1 The "href" Attribute
The "href" attribute contains the link's IRI. atom:link elements MUST
have a href attribute, whose value MUST be a IRI reference [RFC3987].
4.2.7.2 The "rel" Attribute
atom:link elements MAY have a "rel" attribute that indicates the link
relation type. If the "rel" attribute is not present, the link
element MUST be interpreted as if the link relation type is
"alternate".
The value of "rel" MUST be a string that is non-empty, and matches
either the "isegment-nz-nc" or the "IRI" production in [RFC3987].
Note that use of a relative reference other than a simple name is not
allowed. If a name is given, implementations MUST consider the link
relation type to be equivalent to the same name registered within the
IANA Registry of Link Relations (Section 7), and thus the IRI that
would be obtained by appending the value of the rel attribute to the
string "http://www.iana.org/assignments/relation/". The value of
"rel" describes the meaning of the link, but does not impose any
behavioral requirements on Atom Processors.
This document defines five initial values for the Registry of Link
Relations:
1. The value "alternate" signifies that the IRI in the value of the
href attribute identifies an alternate version of the resource
described by the containing element.
2. The value "related" signifies that the IRI in the value of the
href attribute identifies a resource related to the resource
described by the containing element. For example, the feed for a
site that discusses the performance of the search engine at
"http://search.example.com" might contain, as a child of
atom:feed:
<link rel="related" href="http://search.example.com/"/>
An identical link might appear as a child of any atom:entry whose
content contains a discussion of that same search engine.
3. The value "self" signifies that the IRI in the value of the href
attribute identifies a resource equivalent to the containing
element.
4. The value "enclosure" signifies that the IRI in the value of the
href attribute identifies a related resource which is potentially
large in size and might require special handling. For atom:link
elements with rel="enclosure", the length attribute SHOULD be
provided.
5. The value "via" signifies that the IRI in the value of the href
attribute identifies a resource that is the source of the
information provided in the containing element.
On the link element, the "type" attribute's value is an advisory
media type; it is a hint about the type of the representation that is
expected to be returned when the value of the href attribute is
dereferenced. Note that the type attribute does not override the
actual media type returned with the representation. Link elements
MAY have a type attribute, whose value MUST conform to the syntax of
a MIME media type [MIMEREG].
4.2.7.4 The "hreflang" Attribute
The "hreflang" attribute's content describes the language of the
resource pointed to by the href attribute. When used together with
the rel="alternate", it implies a translated version of the entry.
Link elements MAY have an hreflang attribute, whose value MUST be a
language tag [RFC3066].
4.2.7.5 The "title" Attribute
The "title" attribute conveys human-readable information about the
link. The content of the "title" attribute is Language-Sensitive.
Entities such as "&" and "<" represent their corresponding
characters ("&" and "<" respectively), not markup. Link elements MAY
have a title attribute.
4.2.7.6 The "length" Attribute
The "length" attribute indicates an advisory length of the linked
content in octets; it is a hint about the content length of the
representation returned when the IRI in the href attribute is mapped
to a URI and dereferenced. Note that the length attribute does not
override the actual content length of the representation as reported
by the underlying protocol. Link elements MAY have a length
attribute.
|
Constructor Summary |
Link()
|
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Link
public Link()
getHref
public java.net.URI getHref()
setHref
public void setHref(java.net.URI href)
getType
public java.net.URI getType()
setType
public void setType(java.net.URI type)
getHreflang
public org.hccp.atom.LanguageTag getHreflang()
setHreflang
public void setHreflang(org.hccp.atom.LanguageTag hreflang)
getTitle
public java.lang.String getTitle()
setTitle
public void setTitle(java.lang.String title)
getLength
public java.lang.String getLength()
setLength
public void setLength(java.lang.String length)
getRel
public java.lang.String getRel()
setRel
public void setRel(java.lang.String rel)