|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.beans.FeatureDescriptor atg.beans.SerializableFeatureDescriptor atg.beans.DynamicPropertyDescriptor atg.repository.RepositoryPropertyDescriptor atg.repository.FilePropertyDescriptor
public class FilePropertyDescriptor
This is a simple read-only property descriptor which takes a path name and converts this to a java.io.File object. You can optionally prepend a prefix onto the path name.
You can use this property to expose content through the GSA which is stored in the system as a path name. If you define this property in an item-descriptor with the content="true" attribute set, the ItemPath of the content item is used (optionally in conjunction with the pathPrefix value) to determine the file system path of the file for this property.
If this property is not part of a content repository item, you must specify a pathName property feature descriptor attribute. That attribute specifies the name of a property to use to retrieve the path of the file. The path is appended onto the pathPrefix if one is specified.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
protected java.lang.String |
mPathNameProperty
Values of these attributes for this particular property |
protected java.lang.String |
mPathPrefix
|
protected static java.lang.String |
PATH_NAME_PROPERTY
|
protected static java.lang.String |
PATH_PREFIX
Attribute names |
protected static java.lang.String |
TYPE_NAME
|
Fields inherited from class atg.repository.RepositoryPropertyDescriptor |
---|
EMPTY_LIST, EMPTY_MAP, EMPTY_SET, FOREIGN_REPOSITORY_NAME, mCollectionOrMap |
Fields inherited from class atg.beans.DynamicPropertyDescriptor |
---|
PORTABLE_VALUE_KEY |
Fields inherited from class atg.beans.SerializableFeatureDescriptor |
---|
BUNDLE_ATTRIBUTE_NAME, LOCALE_ATTRIBUTE_NAME |
Constructor Summary | |
---|---|
FilePropertyDescriptor()
Constructs a new FilePropertyDescriptor |
|
FilePropertyDescriptor(java.lang.String pPropertyName)
Constructs a new FilePropertyDescriptor for a particular property. |
|
FilePropertyDescriptor(java.lang.String pPropertyName,
java.lang.Class pPropertyType,
java.lang.String pShortDescription)
Constructs a new RepositoryPropertyDescriptor with the given property name, property type, and short description. |
Method Summary | |
---|---|
java.lang.Class |
getPropertyType()
The Java type info for the property. |
java.lang.Object |
getPropertyValue(RepositoryItemImpl pItem,
java.lang.Object pValue)
This method is called to retrieve a read-only value for this property. |
java.lang.String |
getTypeName()
Returns the name this type uses in the XML file. |
boolean |
isQueryable()
Returns property Queryable |
boolean |
isWritable()
Returns property Writable. |
void |
setComponentItemDescriptor(RepositoryItemDescriptor pDesc)
Sets the property ComponentItemDescriptor. |
void |
setComponentPropertyType(java.lang.Class pClass)
Sets the property ComponentPropertyType. |
void |
setPropertyItemDescriptor(RepositoryItemDescriptor pDesc)
Sets the property PropertyItemDescriptor. |
void |
setPropertyType(java.lang.Class pClass)
Perform type checking. |
void |
setValue(java.lang.String pAttributeName,
java.lang.Object pValue)
Catch the attribute values that we care about and store them in member variables. |
Methods inherited from class atg.beans.DynamicPropertyDescriptor |
---|
createLocalePropertyEditor, createLocalePropertyEditor, createPropertyEditor, getComponentPropertyType, getPropertyEditorClass, getUIPropertyEditor, isReadable, isRequired, setPropertyEditorClass, setReadable, setRequired, setWritable |
Methods inherited from class atg.beans.SerializableFeatureDescriptor |
---|
copyFeatureDescriptor, getDisplayName, getDisplayNameResource, getDisplaySortString, getShortDescription, getShortDescriptionResource, getSortString, setDisplayNameResource, setShortDescriptionResource |
Methods inherited from class java.beans.FeatureDescriptor |
---|
attributeNames, getName, getValue, isExpert, isHidden, isPreferred, setDisplayName, setExpert, setHidden, setName, setPreferred, setShortDescription |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
protected static final java.lang.String PATH_PREFIX
protected static final java.lang.String PATH_NAME_PROPERTY
protected static final java.lang.String TYPE_NAME
protected java.lang.String mPathNameProperty
protected java.lang.String mPathPrefix
Constructor Detail |
---|
public FilePropertyDescriptor()
public FilePropertyDescriptor(java.lang.String pPropertyName)
public FilePropertyDescriptor(java.lang.String pPropertyName, java.lang.Class pPropertyType, java.lang.String pShortDescription)
Method Detail |
---|
public boolean isQueryable()
isQueryable
in class RepositoryPropertyDescriptor
public boolean isWritable()
isWritable
in class DynamicPropertyDescriptor
public java.lang.Object getPropertyValue(RepositoryItemImpl pItem, java.lang.Object pValue)
getPropertyValue
in class RepositoryPropertyDescriptor
public void setValue(java.lang.String pAttributeName, java.lang.Object pValue)
setValue
in class RepositoryPropertyDescriptor
public java.lang.String getTypeName()
getTypeName
in class RepositoryPropertyDescriptor
public java.lang.Class getPropertyType()
DynamicPropertyDescriptor
getPropertyType
in class DynamicPropertyDescriptor
public void setPropertyType(java.lang.Class pClass)
setPropertyType
in class RepositoryPropertyDescriptor
public void setComponentPropertyType(java.lang.Class pClass)
DynamicPropertyDescriptor
setComponentPropertyType
in class DynamicPropertyDescriptor
pClass
- new value to setpublic void setPropertyItemDescriptor(RepositoryItemDescriptor pDesc)
RepositoryPropertyDescriptor
setPropertyItemDescriptor
in class RepositoryPropertyDescriptor
pDesc
- new value to setpublic void setComponentItemDescriptor(RepositoryItemDescriptor pDesc)
RepositoryPropertyDescriptor
setComponentItemDescriptor
in class RepositoryPropertyDescriptor
pDesc
- new value to set
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |