How to use

org.apache.sis.metadata.iso.citation.DefaultOnlineResource

constructor

/**
 * Returns a SIS metadata implementation with the values of the given arbitrary implementation.
 * This method performs the first applicable action in the following choices:
 *
 * <ul>
 *   <li>If the given object is {@code null}, then this method returns {@code null}.</li>
 *   <li>Otherwise if the given object is already an instance of
 *       {@code DefaultOnlineResource}, then it is returned unchanged.</li>
 *   <li>Otherwise a new {@code DefaultOnlineResource} instance is created using the
 *       {@linkplain #DefaultOnlineResource(OnlineResource) copy constructor}
 *       and returned. Note that this is a <cite>shallow</cite> copy operation, since the other
 *       metadata contained in the given object are not recursively copied.</li>
 * </ul>
 *
 * @param  object  the object to get as a SIS implementation, or {@code null} if none.
 * @return a SIS implementation containing the values of the given object (may be the
 *         given object itself), or {@code null} if the argument was null.
 */
public static DefaultOnlineResource castOrCopy(final OnlineResource object) {
  if (object == null || object instanceof DefaultOnlineResource) {
    return (DefaultOnlineResource) object;
  }
  return new DefaultOnlineResource(object);
}

/**
 * Returns a SIS metadata implementation with the values of the given arbitrary implementation.
 * This method performs the first applicable action in the following choices:
 *
 * <ul>
 *   <li>If the given object is {@code null}, then this method returns {@code null}.</li>
 *   <li>Otherwise if the given object is already an instance of
 *       {@code DefaultOnlineResource}, then it is returned unchanged.</li>
 *   <li>Otherwise a new {@code DefaultOnlineResource} instance is created using the
 *       {@linkplain #DefaultOnlineResource(OnlineResource) copy constructor}
 *       and returned. Note that this is a <cite>shallow</cite> copy operation, since the other
 *       metadata contained in the given object are not recursively copied.</li>
 * </ul>
 *
 * @param  object  the object to get as a SIS implementation, or {@code null} if none.
 * @return a SIS implementation containing the values of the given object (may be the
 *         given object itself), or {@code null} if the argument was null.
 */
public static DefaultOnlineResource castOrCopy(final OnlineResource object) {
  if (object == null || object instanceof DefaultOnlineResource) {
    return (DefaultOnlineResource) object;
  }
  return new DefaultOnlineResource(object);
}

/**
 * Wraps the given URI in a {@code <cit:OnlineResource>} element.
 */
@Override
public CI_OnlineResource marshal(final URI value) {
  if (value != null) {
    return ADAPTER.marshal(new DefaultOnlineResource(value));
  }
  return null;
}

/**
 * Creates an {@code OnlineResource} element if the given URL is not null. Since ISO 19115
 * declares the URL as a mandatory attribute, this method will ignore all other attributes
 * if the given URL is null.
 *
 * @param  url   the URL (mandatory - if {@code null}, no resource will be created).
 * @return the online resource, or {@code null} if the URL was null.
 */
private OnlineResource createOnlineResource(final String url) {
  final URI uri = createURI(url);
  if (uri == null) {
    return null;
  }
  final DefaultOnlineResource resource = new DefaultOnlineResource(uri);
  final String protocol = uri.getScheme();
  resource.setProtocol(protocol);
  if ("http".equalsIgnoreCase(protocol) || "https".equalsIgnoreCase(protocol)) {
    resource.setApplicationProfile("web browser");
  }
  resource.setFunction(OnLineFunction.INFORMATION);
  return resource;
}

/**
 * Creates an {@code OnlineResource} element if the given URL is not null. Since ISO 19115
 * declares the URL as a mandatory attribute, this method will ignore all other attributes
 * if the given URL is null.
 *
 * @param  url   the URL (mandatory - if {@code null}, no resource will be created).
 * @return the online resource, or {@code null} if the URL was null.
 */
private OnlineResource createOnlineResource(final String url) {
  final URI uri = createURI(url);
  if (uri == null) {
    return null;
  }
  final DefaultOnlineResource resource = new DefaultOnlineResource(uri);
  final String protocol = uri.getScheme();
  resource.setProtocol(protocol);
  if ("http".equalsIgnoreCase(protocol) || "https".equalsIgnoreCase(protocol)) {
    resource.setApplicationProfile("web browser");
  }
  resource.setFunction(OnLineFunction.INFORMATION);
  return resource;
}

cit.getOnlineResources().add(new DefaultOnlineResource(resource));
info.setCitation(cit);

/**
 * Adds a URL to a more complete description of the metadata.
 *
 * <ul>
 *   <li>{@code metadata/metadataLinkage/linkage}
 *     with {@code function} set to {@code OnLineFunction.COMPLETE_METADATA}</li>
 * </ul>
 *
 * @param  link
 */
public final void addCompleteMetadata(final URI link) {
  if (link != null) {
    final DefaultOnlineResource ln = new DefaultOnlineResource(link);
    ln.setFunction(OnLineFunction.valueOf("COMPLETE_METADATA"));
    ln.setProtocol(link.getScheme());
    addIfNotPresent(metadata().getMetadataLinkages(), ln);
  }
}

/**
 * Adds a URL to a more complete description of the metadata.
 * Storage location is:
 *
 * <ul>
 *   <li>{@code metadata/metadataLinkage/linkage}
 *     with {@code function} set to {@code OnLineFunction.COMPLETE_METADATA}</li>
 * </ul>
 *
 * @param  link  URL to a more complete description of the metadata, or {@code null}.
 */
public final void addCompleteMetadata(final URI link) {
  if (link != null) {
    final DefaultOnlineResource ln = new DefaultOnlineResource(link);
    ln.setFunction(OnLineFunction.valueOf("COMPLETE_METADATA"));
    ln.setProtocol(link.getScheme());
    addIfNotPresent(metadata().getMetadataLinkages(), ln);
  }
}

final DefaultOnlineResource r = new DefaultOnlineResource();
try {
  r.setLinkage(new URI(url));

final DefaultOnlineResource r = new DefaultOnlineResource();
try {
  r.setLinkage(new URI(url));

DefaultOnlineResource firstOnline = DefaultOnlineResource.castOrCopy(CollectionsExt.first(onlineResources));
if (firstOnline == null) {
  firstOnline = new DefaultOnlineResource();

DefaultOnlineResource firstOnline = DefaultOnlineResource.castOrCopy(CollectionsExt.first(onlineResources));
if (firstOnline == null) {
  firstOnline = new DefaultOnlineResource();

/**
 * Tests XML marshalling for the given metadata version.
 *
 * @param  file     file containing the expected metadata.
 * @param  version  the metadata version to marshal.
 */
private void testMarshalling(final String file, final Version version) throws JAXBException {
  final DefaultOnlineResource rs = new DefaultOnlineResource(URI.create("https://tools.ietf.org/html/rfc1149"));
  rs.setName("IP over Avian Carriers");
  rs.setDescription(new SimpleInternationalString("High delay, low throughput, and low altitude service."));
  rs.setFunction(OnLineFunction.OFFLINE_ACCESS);
  final DefaultContact contact = new DefaultContact(rs);
  contact.setContactInstructions(new SimpleInternationalString("Send carrier pigeon."));
  contact.getIdentifierMap().putSpecialized(IdentifierSpace.ID, "ip-protocol");
  final DefaultCitation c = new DefaultCitation("Fight against poverty");
  final DefaultResponsibleParty r1 = new DefaultResponsibleParty(Role.ORIGINATOR);
  final DefaultResponsibleParty r2 = new DefaultResponsibleParty(Role.valueOf("funder"));
  r1.setParties(Collections.singleton(new DefaultIndividual("Maid Marian", null, contact)));
  r2.setParties(Collections.singleton(new DefaultIndividual("Robin Hood",  null, contact)));
  c.setCitedResponsibleParties(Arrays.asList(r1, r2));
  c.getDates().add(new DefaultCitationDate(TestUtilities.date("2015-10-17 00:00:00"), DateType.valueOf("adopted")));
  c.getPresentationForms().add(PresentationForm.valueOf("physicalObject"));
  /*
   * Check that XML file built by the marshaller is the same as the example file.
   */
  assertMarshalEqualsFile(file, c, version, "xmlns:*", "xsi:schemaLocation");
}

final Anchor country = new Anchor(URI.create("SDN:C320:2:FR"), "France"); // Non-public SIS class.
  final DefaultOnlineResource online = new DefaultOnlineResource(URI.create("http://www.ifremer.fr/sismer/"));
  online.setProtocol("http");
  final DefaultContact contact = new DefaultContact(online);
    final DefaultOnlineResource online = new DefaultOnlineResource(URI.create("http://www.com.univ-mrs.fr/LOB/"));
    online.setProtocol("http");
    final DefaultContact contact = new DefaultContact(online);
  final DefaultOnlineResource onlines = new DefaultOnlineResource(URI.create("http://www.ifremer.fr/data/something"));
  onlines.setDescription(new SimpleInternationalString("CTDF02"));
  onlines.setFunction(OnLineFunction.DOWNLOAD);