no.ingeberg.NewsML
Class NewsComponent

java.lang.Object
  extended by no.ingeberg.NewsML.NewsComponent

public class NewsComponent
extends java.lang.Object

NewsComponent.java
Klassen h�ndterer innkomne data under "NewsComponent" elementet, som er et beholder objekt som grupperer sammen ulike nyhetsobjekt (nyhetsposter, nyhetspost referanser, og nyhetskomponenter) og innholds element. Klassen jobber mot sub-klassen NewsComponent class, som tar seg av h�ndteringa av NewsItem | NewsItemRef | NewsComponent | ContentItem elementene der kun en var de skal forekomme. Klassen innholder og metoder for � hente ut disse formatert som xml, etter NewsML DTD'en.


Constructor Summary
NewsComponent()
           
NewsComponent(java.lang.String comment, NewsLines newsLines, AdminMetadata administrativeMetadata, NewsComponentSub newsComponentSub)
          Oppretter en ny istans av NewsComponent, i denne konstruktoren følgende under-elementene tatt med
NewsComponent(java.lang.String essential, java.lang.String equivalentsList, java.lang.String xmlLang, java.lang.String comment, Catalog catalog, TopicSet topicSet, java.lang.String role, java.lang.String basisForChoice, NewsLines newsLines, AdminMetadata administrativeMetadata, RightsMetadata rightsMetadata, DescriptiveMetadata descriptiveMetadata, java.lang.String metadata, java.lang.String metadataProperty, NewsComponentSub newsComponentSub)
          Oppretter en ny istans av NewsComponent, i denne konstruktoren er alle under-elementene tatt med
 
Method Summary
 void addBasisForChoice(java.lang.String basisForChoice)
          Metoden legger til "ekstra" basisForChoice element.
 void addComment(java.lang.String comment)
          Metoden legger til "ekstra" comment element.
 void addTopicSet(TopicSet topicSet)
          Metoden legger til "ekstra" topicSet element.
 java.lang.String getNewsComponent()
          Metoden returnerer alle NewsComponent variablene, i xml-format.
 void setAdminMetadata(AdminMetadata administrativeMetadata)
          Setter AdminsitrativMetadata elementet
 void setCatalog(Catalog catalog)
          Metoden setter catalog element.
 void setDescriptiveMetadata(DescriptiveMetadata descriptiveMetadata)
          Setter DescriptiveMetadata elementet
 void setEquivalentsList(java.lang.String equivalentsList)
          Metoden setter essential attributtet.
 void setEssential(java.lang.String essential)
          Metoden setter essential attributtet.
 void setMetadata(java.lang.String metadata)
          Setter metadata elementet
 void setMetadataProperty(java.lang.String metadataProperty)
          Setter metadataproperty elementet
 void setNewsComponentSub(NewsComponentSub newsComponentSub)
          legger til 1 NewsComponentSub element
 void setNewsLines(NewsLines newsLines)
          Setter NewsLines elementet
 void setRightsMetadata(RightsMetadata rightsMetadata)
          Setter rightsMetadata elementet
 void setRole(java.lang.String role)
          Setter role elementet
 void setXmlLang(java.lang.String xmlLang)
          Metoden setter essential attributtet.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

NewsComponent

public NewsComponent(java.lang.String essential,
                     java.lang.String equivalentsList,
                     java.lang.String xmlLang,
                     java.lang.String comment,
                     Catalog catalog,
                     TopicSet topicSet,
                     java.lang.String role,
                     java.lang.String basisForChoice,
                     NewsLines newsLines,
                     AdminMetadata administrativeMetadata,
                     RightsMetadata rightsMetadata,
                     DescriptiveMetadata descriptiveMetadata,
                     java.lang.String metadata,
                     java.lang.String metadataProperty,
                     NewsComponentSub newsComponentSub)
Oppretter en ny istans av NewsComponent, i denne konstruktoren er alle under-elementene tatt med

Parameters:
essential - Indikerer om utgiver anser denne nyhetskomponentet til � av essensiell i forhold til konteksten der den st�r. Her kan en velge mellom �yes� og �no�. �No� er satt som default.

equivalentsList - Indikerer om de elementene som nyhetskomponenten best�r av er alternative objekter. Slik som n�r en artikkel er tilgjenglig i ulike typer spr�k. Her kan en velge mellom �yes� og �no�. �No� er satt som default.

xmlLang - Angir spr�ket i nyhetskomponenten. M� angis i IETF RFC 3066.

comment - Kommentar element.

catalog - Identifiserer standard vokabular for newsComponent.
Den kan og indikerer hvor i NewsML dokumentet visse Topics er brukt.
Elementet er frivillig, og kan kun forekomme 1 gang.

topicSet - Beskriver emnet til nyhetskomponentet.

role - Spesifiserer rollen en nyhetskomponent spiller i den nyhetskomponenten den er den del av.

basisForChoice - Hvis det finnes flere alternative elementer i attributtetet �equivalentsList�, angir en de komponentene her. Dette elementet bruker et Xpath m�nster, eller en element-type navn for � identifisere den rette komponenten i forhold til de egenskapene som er gitt.

newsLines - Angir karakteristiske egenskaper ved nyhetsobjektet. Disse er ment � tilf�re en representasjon av metadata som er lett tilgjenglig for mennesker.

administrativeMetadata - Angir metadata som forteller om opprinnelsen til nyhetskomponenten.

rightsMetadata - Angir metadata innholder informasjon om opphavsrett, og rett til bruk vedr�rende nyhetskomponentene.

descriptiveMetadata - Angir metadata innholder informasjon som beskriver innholdet til en nyhetskomponent.

metadata - Angir metadata som ikke er dekket av de �vrige. Gir metadata type navn.

metadataProperty - Angir metadata som ikke er dekket av de �vrige. Gir metadata verdi.

newsComponentSub - Kaller et av elementene: NewsItem | NewsItemRef | NewsComponent | ContentItem der kun et av de skal forekomme.


NewsComponent

public NewsComponent(java.lang.String comment,
                     NewsLines newsLines,
                     AdminMetadata administrativeMetadata,
                     NewsComponentSub newsComponentSub)
Oppretter en ny istans av NewsComponent, i denne konstruktoren følgende under-elementene tatt med

Parameters:
comment - Kommentar element.

newsLines - Angir karakteristiske egenskaper ved nyhetsobjektet. Disse er ment � tilf�re en representasjon av metadata som er lett tilgjenglig for mennesker.

administrativeMetadata - Angir metadata som forteller om opprinnelsen til nyhetskomponenten.

newsComponentSub - Kaller et av elementene: NewsItem | NewsItemRef | NewsComponent | ContentItem der kun et av de skal forekomme.


NewsComponent

public NewsComponent()
Method Detail

setEssential

public void setEssential(java.lang.String essential)
Metoden setter essential attributtet.

Parameters:
essential - Indikerer om utgiver anser denne nyhetskomponentet til å av essensiell i forhold til konteksten der den st�r. Her kan en velge mellom �yes� og �no�. �No� er satt som default.


setEquivalentsList

public void setEquivalentsList(java.lang.String equivalentsList)
Metoden setter essential attributtet.

Parameters:
equivalentsList - Indikerer om de elementene som nyhetskomponenten består av er alternative objekter. Slik som n�r en artikkel er tilgjenglig i ulike typer spr�k. Her kan en velge mellom �yes� og �no�. �No� er satt som default.

setXmlLang

public void setXmlLang(java.lang.String xmlLang)
Metoden setter essential attributtet.

Parameters:
xmlLang - Angir spr�ket i nyhetskomponenten. M� angis i IETF RFC 3066.

addComment

public void addComment(java.lang.String comment)
Metoden legger til "ekstra" comment element. Kan gjentaes s� ofte som �nskelig.

Parameters:
comment - Kommentar element.

setCatalog

public void setCatalog(Catalog catalog)
Metoden setter catalog element.

Parameters:
catalog - Identifiserer standard vokabular for newsComponent.
Den kan og indikerer hvor i NewsML dokumentet visse Topics er brukt.
Elementet er frivillig, og kan kun forekomme 1 gang.

addTopicSet

public void addTopicSet(TopicSet topicSet)
Metoden legger til "ekstra" topicSet element. Kan gjentaes s� ofte som �nskelig.

Parameters:
topicSet - Beskriver emnet til nyhetskomponentet.


addBasisForChoice

public void addBasisForChoice(java.lang.String basisForChoice)
Metoden legger til "ekstra" basisForChoice element. Kan gjentaes s� ofte som �nskelig.

Parameters:
basisForChoice - Hvis det finnes flere alternative elementer i attributtetet �equivalentsList�, angir en de komponentene her. Dette elementet bruker et Xpath m�nster, eller en element-type navn for � identifisere den rette komponenten i forhold til de egenskapene som er gitt.


setRole

public void setRole(java.lang.String role)
Setter role elementet

Parameters:
role - Spesifiserer rollen en nyhetskomponent spiller i den nyhetskomponenten den er den del av.


setNewsLines

public void setNewsLines(NewsLines newsLines)
Setter NewsLines elementet

Parameters:
newsLines - Angir karakteristiske egenskaper ved nyhetsobjektet. Disse er ment � tilf�re en representasjon av metadata som er lett tilgjenglig for mennesker.


setAdminMetadata

public void setAdminMetadata(AdminMetadata administrativeMetadata)
Setter AdminsitrativMetadata elementet

Parameters:
administrativeMetadata - Angir metadata som forteller om opprinnelsen til nyhetskomponenten.

setRightsMetadata

public void setRightsMetadata(RightsMetadata rightsMetadata)
Setter rightsMetadata elementet

Parameters:
rightsMetadata - Angir metadata innholder informasjon om opphavsrett, og rett til bruk vedr�rende nyhetskomponentene.

setDescriptiveMetadata

public void setDescriptiveMetadata(DescriptiveMetadata descriptiveMetadata)
Setter DescriptiveMetadata elementet

Parameters:
descriptiveMetadata - Angir metadata innholder informasjon som beskriver innholdet til en nyhetskomponent.

setMetadata

public void setMetadata(java.lang.String metadata)
Setter metadata elementet

Parameters:
metadata - Angir metadata som ikke er dekket av de �vrige. Gir metadata type navn.

setMetadataProperty

public void setMetadataProperty(java.lang.String metadataProperty)
Setter metadataproperty elementet

Parameters:
metadataProperty - Angir metadata som ikke er dekket av de �vrige. Gir metadata verdi.

setNewsComponentSub

public void setNewsComponentSub(NewsComponentSub newsComponentSub)
legger til 1 NewsComponentSub element

Parameters:
newsComponentSub - Kaller et av elementene: NewsItem | NewsItemRef | NewsComponent | ContentItem der kun et av de skal forekomme.

getNewsComponent

public java.lang.String getNewsComponent()
Metoden returnerer alle NewsComponent variablene, i xml-format.


toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object