Package org.apache.juneau.bean.atom

Class Source

java.lang.Object
org.apache.juneau.bean.atom.Common
org.apache.juneau.bean.atom.CommonEntry<Source>
org.apache.juneau.bean.atom.Source
public class Source extends CommonEntry<Source>
Represents metadata from the source feed when an entry is copied from one feed to another.

When entries are aggregated, copied, or republished from their original feed, the source element preserves metadata about the original feed. This is crucial for proper attribution and maintaining provenance information.

The source element is a child of entry and contains a subset of feed-level metadata that identifies where the entry originally came from. All child elements are optional, but including at minimum the source feed's ID, title, and updated timestamp is recommended.

Common use cases:

  • Feed aggregation - Combining entries from multiple sources
  • Content syndication - Republishing entries from other feeds
  • Attribution - Crediting the original source
Schema

atomSource = element atom:source { atomCommonAttributes, (atomAuthor* & atomCategory* & atomContributor* & atomGenerator? & atomIcon? & atomId? & atomLink* & atomLogo? & atomRights? & atomSubtitle? & atomTitle? & atomUpdated? & extensionElement*) }

Example:

// Entry copied from another feed Entry entry = new Entry( "tag:myaggregator.example.com,2024:entry1", "Interesting Article", "2024-01-15T12:00:00Z" ) .setSource( new Source() .setId("tag:originalblog.example.com,2024:feed") .setTitle("Original Blog") .setUpdated("2024-01-15T12:00:00Z") .setLinks( new Link("self", "application/atom+xml", "http://originalblog.example.com/feed.atom") ) );

Specification:

Represents an atomSource construct in the RFC 4287 - Section 4.2.11 specification.

See Also:

  • Constructor Details

  • Method Details

    • getGenerator

      public Generator getGenerator()
      Bean property getter: generator.

      The generator info of this source.

      Returns:
      The property value, or null if it is not set.

    • getIcon

      public Icon getIcon()
      Bean property getter: icon.

      The icon of this source.

      Returns:
      The property value, or null if it is not set.

    • getLogo

      public Logo getLogo()
      Bean property getter: logo.

      The logo of this source.

      Returns:
      The property value, or null if it is not set.

    • getSubtitle

      public Text getSubtitle()
      Bean property getter: subtitle.

      The subtitle of this source.

      Returns:
      The property value, or null if it is not set.

    • setGenerator

      public Source setGenerator(Generator value)
      Bean property setter: generator.

      The generator info of this source.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • setIcon

      public Source setIcon(Icon value)
      Bean property setter: icon.

      The icon of this source.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • setLogo

      public Source setLogo(Logo value)
      Bean property setter: logo.

      The logo of this source.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • setSubtitle

      public Source setSubtitle(String value)
      Bean property fluent setter: subtitle.

      The subtitle of this source.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object.

    • setSubtitle

      public Source setSubtitle(Text value)
      Bean property setter: subtitle.

      The subtitle of this source.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object