/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/* $Id: PropertyAccess.java 1345683 2012-06-03 14:50:33Z gadams $ */

package org.apache.xmlgraphics.xmp;

import java.util.Iterator;

import org.apache.xmlgraphics.util.QName;

This interface is implemented by the top-level Metadata class and stuctured properties.
/** * This interface is implemented by the top-level Metadata class and stuctured properties. */
public interface PropertyAccess {
Sets a property.
Params:
  • prop – the property
/** * Sets a property. * @param prop the property */
void setProperty(XMPProperty prop);
Returns a property
Params:
  • uri – the namespace URI of the property
  • localName – the local name of the property
Returns:the requested property or null if it's not available
/** * Returns a property * @param uri the namespace URI of the property * @param localName the local name of the property * @return the requested property or null if it's not available */
XMPProperty getProperty(String uri, String localName);
Returns a property.
Params:
  • name – the name of the property
Returns:the requested property or null if it's not available
/** * Returns a property. * @param name the name of the property * @return the requested property or null if it's not available */
XMPProperty getProperty(QName name);
Removes a property and returns it if it was found.
Params:
  • name – the name of the property
Returns:the removed property or null if it was not found
/** * Removes a property and returns it if it was found. * @param name the name of the property * @return the removed property or null if it was not found */
XMPProperty removeProperty(QName name);
Returns the rdf:value property. This is a shortcut for getProperty(XMPConstants.RDF_VALUE).
Returns:the rdf:value property or null if it's no available
/** * Returns the rdf:value property. This is a shortcut for getProperty(XMPConstants.RDF_VALUE). * @return the rdf:value property or null if it's no available */
XMPProperty getValueProperty();
Returns the number of properties.
Returns:the number of properties in this metadata object.
/** * Returns the number of properties. * @return the number of properties in this metadata object. */
int getPropertyCount();
Returns an Iterator over all properties in this structured property.
Returns:an Iterator over all properties
/** * Returns an Iterator over all properties in this structured property. * @return an Iterator over all properties */
Iterator iterator(); }