org.fcrepo.kernel.impl.utils

Class FedoraTypesUtils

java.lang.Object

org.fcrepo.kernel.impl.utils.FedoraTypesUtils

All Implemented Interfaces:

FedoraJcrTypes

public abstract class FedoraTypesUtils
extends Object
implements FedoraJcrTypes

Convenience class with static methods for manipulating Fedora types in the JCR.

Since:

Feb 14, 2013

Author:

ajs6f

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.common.base.Predicate<javax.jcr.Node>	isBlankNode Predicate for determining whether this Node is a Fedora binary.
static com.google.common.base.Predicate<javax.jcr.Node>	isContainer Predicate for determining whether this Node is a Fedora object.
static com.google.common.base.Predicate<javax.jcr.Node>	isFedoraBinary Predicate for determining whether this Node is a Fedora binary.
static com.google.common.base.Predicate<FedoraResource>	isFrozenNode Predicate for determining whether this FedoraResource has a frozen node
static com.google.common.base.Predicate<javax.jcr.Node>	isInternalNode Check if a node is "internal" and should not be exposed e.g.
static com.google.common.base.Predicate<javax.jcr.Property>	isInternalProperty Check whether a property is an internal property that should be suppressed from external output.
static com.google.common.base.Predicate<javax.jcr.Property>	isInternalReferenceProperty Check if a property is a reference property.
static com.google.common.base.Predicate<javax.jcr.Node>	isNonRdfSourceDescription Predicate for determining whether this Node is a Fedora datastream.
static com.google.common.base.Predicate<javax.jcr.Property>	isProtectedAndShouldBeHidden Check whether a property is protected (ie, cannot be modified directly) but is not one we've explicitly chosen to include.
static String	REFERENCE_PROPERTY_SUFFIX

Fields inherited from interface org.fcrepo.kernel.FedoraJcrTypes

CONTENT_DIGEST, CONTENT_SIZE, EXPOSED_PROTECTED_JCR_TYPES, FCR_METADATA, FCR_VERSIONS, FEDORA_BINARY, FEDORA_BLANKNODE, FEDORA_CONTAINER, FEDORA_NON_RDF_SOURCE_DESCRIPTION, FEDORA_PAIRTREE, FEDORA_RESOURCE, FEDORA_TOMBSTONE, FROZEN_MIXIN_TYPES, FROZEN_NODE, JCR_CREATED, JCR_CREATEDBY, JCR_FROZEN_NODE, JCR_LASTMODIFIED, JCR_MIXIN_TYPES, JCR_PRIMARY_TYPE, JCR_UUID, LDP_BASIC_CONTAINER, LDP_DIRECT_CONTAINER, LDP_HAS_MEMBER_RELATION, LDP_INDIRECT_CONTAINER, LDP_INSERTED_CONTENT_RELATION, LDP_IS_MEMBER_OF_RELATION, LDP_MEMBER_RESOURCE, PREMIS_FILE_NAME, ROOT, VERSIONABLE

Constructor Summary

Constructors

Constructor and Description
FedoraTypesUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static javax.jcr.Node	getClosestExistingAncestor(javax.jcr.Session session, String path) Get the closest ancestor that current exists
static javax.jcr.nodetype.PropertyDefinition	getDefinitionForPropertyName(javax.jcr.Node node, String propertyName) Get the property definition information (containing type and multi-value information)
static int	getPropertyType(javax.jcr.Node node, String propertyName) Get the JCR property type ID for a given property name.
static String	getReferencePropertyName(String propertyName) When we add certain URI properties, we also want to leave a reference node
static String	getReferencePropertyOriginalName(String refPropertyName) Given an internal reference node property, get the original name
static boolean	isMultivaluedProperty(javax.jcr.Node node, String propertyName) Determine if a given JCR property name is single- or multi- valued.
static boolean	isReferenceProperty(javax.jcr.Node node, String propertyName) Check if a property definition is a reference property

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

REFERENCE_PROPERTY_SUFFIX

public static final String REFERENCE_PROPERTY_SUFFIX

See Also:

Constant Field Values

isContainer

public static com.google.common.base.Predicate<javax.jcr.Node> isContainer

Predicate for determining whether this Node is a Fedora object.

isNonRdfSourceDescription

public static com.google.common.base.Predicate<javax.jcr.Node> isNonRdfSourceDescription

Predicate for determining whether this Node is a Fedora datastream.

isFedoraBinary

public static com.google.common.base.Predicate<javax.jcr.Node> isFedoraBinary

Predicate for determining whether this Node is a Fedora binary.

isFrozenNode

public static com.google.common.base.Predicate<FedoraResource> isFrozenNode

Predicate for determining whether this FedoraResource has a frozen node

isBlankNode

public static com.google.common.base.Predicate<javax.jcr.Node> isBlankNode

Predicate for determining whether this Node is a Fedora binary.

isInternalReferenceProperty

public static com.google.common.base.Predicate<javax.jcr.Property> isInternalReferenceProperty

Check if a property is a reference property.

isInternalProperty

public static com.google.common.base.Predicate<javax.jcr.Property> isInternalProperty

Check whether a property is an internal property that should be suppressed from external output.

isProtectedAndShouldBeHidden

public static com.google.common.base.Predicate<javax.jcr.Property> isProtectedAndShouldBeHidden

Check whether a property is protected (ie, cannot be modified directly) but is not one we've explicitly chosen to include.

isInternalNode

public static com.google.common.base.Predicate<javax.jcr.Node> isInternalNode

Check if a node is "internal" and should not be exposed e.g. via the REST API

Constructor Detail

FedoraTypesUtils

public FedoraTypesUtils()

Method Detail

getPropertyType

public static int getPropertyType(javax.jcr.Node node,
                  String propertyName)
                           throws javax.jcr.RepositoryException

Get the JCR property type ID for a given property name. If unsure, mark it as UNDEFINED.

Parameters:

node - the JCR node to add the property on

propertyName - the property name

Returns:

a PropertyType value

Throws:

javax.jcr.RepositoryException

isMultivaluedProperty

public static boolean isMultivaluedProperty(javax.jcr.Node node,
                            String propertyName)
                                     throws javax.jcr.RepositoryException

Determine if a given JCR property name is single- or multi- valued. If unsure, choose the least restrictive option (multivalued)

Parameters:

node - the JCR node to check

propertyName - the property name (which may or may not already exist)

Returns:

true if the property is (or could be) multivalued

Throws:

javax.jcr.RepositoryException

getDefinitionForPropertyName

public static javax.jcr.nodetype.PropertyDefinition getDefinitionForPropertyName(javax.jcr.Node node,
                                                                 String propertyName)
                                                                          throws javax.jcr.RepositoryException

Get the property definition information (containing type and multi-value information)

Parameters:

node - the node to use for inferring the property definition

propertyName - the property name to retrieve a definition for

Returns:

a JCR PropertyDefinition, if available, or null

Throws:

javax.jcr.RepositoryException

getReferencePropertyName

public static String getReferencePropertyName(String propertyName)

When we add certain URI properties, we also want to leave a reference node

Parameters:

propertyName -

Returns:

property name as a reference

getReferencePropertyOriginalName

public static String getReferencePropertyOriginalName(String refPropertyName)

Given an internal reference node property, get the original name

Parameters:

refPropertyName -

Returns:

original property name of the reference property

isReferenceProperty

public static boolean isReferenceProperty(javax.jcr.Node node,
                          String propertyName)
                                   throws javax.jcr.RepositoryException

Check if a property definition is a reference property

Parameters:

node -

propertyName -

Returns:

Throws:

javax.jcr.RepositoryException

getClosestExistingAncestor

public static javax.jcr.Node getClosestExistingAncestor(javax.jcr.Session session,
                                        String path)
                                                 throws javax.jcr.RepositoryException

Get the closest ancestor that current exists

Parameters:

session -

path -

Returns:

Throws:

javax.jcr.RepositoryException