com.sapportals.wcm.repository

Class PropertyName

java.lang.Object
  com.sapportals.wcm.util.name.Name
      com.sapportals.wcm.repository.PropertyName

All Implemented Interfaces:

IPropertyName, IName, Serializable

Direct Known Subclasses:

ProviderPrioPropertyName, ShowChildrenPropertyName

public class PropertyName
extends Name
implements IPropertyName, Serializable

The name of a resource's property.

Copyright (c) SAP AG 2001-2002

See Also:

Serialized Form

Constructor Summary

PropertyName(Name name)
Deprecated. since NW04 SPS19 / NW04s SP10, please use PropertyName.getPN() instead

PropertyName(String namespace, String name)
Deprecated. since NW04 SPS19 / NW04s SP10, please use PropertyName.getPN() instead

Method Summary

static IPropertyName	createCollection()
static IPropertyName	createContentLanguage()
static IPropertyName	createContentLength()
static IPropertyName	createContentType()
static IPropertyName	createCreatedBy()
static IPropertyName	createCreationDate()
static IPropertyName	createDescription()
static IPropertyName	createDisplayname()
static IPropertyName	createEnhancedCollection()
static IPropertyName	createETag()
static IPropertyName	createExtension()
static IPropertyName	createFollowLinks() The property with this name has the following semantics: If this property is present on a resource, has type boolean and evaluates to FALSE, then pointers from this resource to others should not be followed.
static IPropertyName	createHidden()
static IPropertyName	createIndexContent() The property with this name has the following semantics: If this property is present on a resource, has type boolean and evaluates to FALSE, then the content of this resource is not suitable for indexing.
static IPropertyName	createLastModified()
static IPropertyName	createLastModifiedBy()
static IPropertyName	createLinkType()
static IPropertyName	createReadOnly()
static IPropertyName	createResourceType()
static IPropertyName	createVersioned()
static List	dumpRegistry() dumps the entire list of property name instances currently cached.
static PropertyName	getPN(Name name) Get a property name from a Name instance.
static PropertyName	getPN(String namespace, String name) Get a property name instance for a given namespace and name.
long	getRegistryHitCount() returns the number of access to this property name instance.

Methods inherited from class com.sapportals.wcm.util.name.Name

equals, equalsNode, get, get, getName, getNamespace, getNamespaceOrNull, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.sapportals.wcm.util.name.IName

getName, getNamespace, getNamespaceOrNull

Constructor Detail

PropertyName

public PropertyName(String namespace,
                    String name)
             throws ResourceException

Deprecated. since NW04 SPS19 / NW04s SP10, please use PropertyName.getPN() instead

Throws:

ResourceException

PropertyName

public PropertyName(Name name)
             throws ResourceException

Deprecated. since NW04 SPS19 / NW04s SP10, please use PropertyName.getPN() instead

Throws:

ResourceException

Method Detail

getRegistryHitCount

public long getRegistryHitCount()

returns the number of access to this property name instance.

Returns:

the number of acesses since put into the internal cache.

dumpRegistry

public static List dumpRegistry()

dumps the entire list of property name instances currently cached.

Returns:

the list of PropertyNames currently being cached.

getPN

public static final PropertyName getPN(String namespace,
                                       String name)
                                throws ResourceException

Get a property name instance for a given namespace and name.

Parameters:

namespace - The namespace string or null for a local name.

name - The name of the property. It must not contain whitespaces and must not start with a digit ('0'...'9') character.

Returns:

a PropertyName instance for the given namespace and name.

Throws:

ResourceException - If the property name is invalid (invalid characters or no local name given) TODO : implement

getPN

public static final PropertyName getPN(Name name)
                                throws ResourceException

Get a property name from a Name instance.

Parameters:

name - the Name to get a PropertyName for.

Returns:

a PropertyName instance for the given Name.

Throws:

ResourceException - If the property name is invalid (invalid characters)

NullPointerException - if the given Name is null.

createVersioned

public static IPropertyName createVersioned()

createCreatedBy

public static IPropertyName createCreatedBy()

createLastModifiedBy

public static IPropertyName createLastModifiedBy()

createCreationDate

public static IPropertyName createCreationDate()

createHidden

public static IPropertyName createHidden()

createIndexContent

public static IPropertyName createIndexContent()

The property with this name has the following semantics: If this property is present on a resource, has type boolean and evaluates to FALSE, then the content of this resource is not suitable for indexing. Any crawler visiting this resource shall, under normal operations, not add the content of this resource to any searchable database.

Returns:

name of index-content property

createFollowLinks

public static IPropertyName createFollowLinks()

The property with this name has the following semantics: If this property is present on a resource, has type boolean and evaluates to FALSE, then pointers from this resource to others should not be followed. Any crawler visiting this resource shall, under normal operations, not follow any pointers to other resources. For collection resources this property indicates that the children of this collection should not be crawled. For non-hierarchical resources the intention is that any embedded-links property shall be ignored.

Returns:

name of follow-links property

createExtension

public static IPropertyName createExtension()

createLastModified

public static IPropertyName createLastModified()

createDescription

public static IPropertyName createDescription()

createDisplayname

public static IPropertyName createDisplayname()

createReadOnly

public static IPropertyName createReadOnly()

createContentLength

public static IPropertyName createContentLength()

createContentType

public static IPropertyName createContentType()

createETag

public static IPropertyName createETag()

createEnhancedCollection

public static IPropertyName createEnhancedCollection()

createContentLanguage

public static IPropertyName createContentLanguage()

createResourceType

public static IPropertyName createResourceType()

createCollection

public static IPropertyName createCollection()

createLinkType

public static IPropertyName createLinkType()

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM