/*
* Copyright 2008 FatWire Corporation. All Rights Reserved.
*
* Licensed 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.
*/
package tools.gsf.facade.assetapi;
import com.fatwire.assetapi.data.AssetData;
import com.fatwire.assetapi.data.AssetId;
import com.fatwire.assetapi.data.AttributeData;
import com.fatwire.assetapi.data.BlobObject;
import com.fatwire.assetapi.def.AttributeDef;
import com.fatwire.assetapi.def.AttributeDefProperties;
import com.fatwire.mda.Dimension;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Date;
import java.util.LinkedList;
import java.util.List;
/**
* Utility class for processing attribute data. Some of the data conversion
* methods have not been thoroughly tested and may therefore require some bug
* fixes.
*
* @author Tony Field
* @author Dolf Dijkstra
* @since Nov 17, 2009
*/
public final class AttributeDataUtils {
private AttributeDataUtils() {
}
/**
* Get the specified attribute field from the AssetData object. If it is not
* found, get the next field listed. Continue until the end of the list.
* Safe to use with a single value. If no data is found for any attribute,
* an exception is thrown.
*
* @param assetData populated AssetData object
* @param orderedAttributeNames vararg array of attribute names that are
* expected to be found and populated in the assetData object
* @return the value, never null
*/
public static String getWithFallback(AssetData assetData, String... orderedAttributeNames) {
for (String attr : orderedAttributeNames) {
AttributeData attrData = assetData.getAttributeData(attr);
if (attrData != null && attrData.getData() != null) {
return attrData.getData().toString();
}
}
throw new IllegalArgumentException("Asset data [" + assetData
+ "] does not contain any of the specified attributes: " + Arrays.asList(orderedAttributeNames));
}
/**
* Get the specified attribute data, converting each of the values into a
* string and separating them with a comma (no space).
*
* @param attributeData multi-valued attribute data
* @return attribute data converted to a string, comma-separated.
*/
public static String getMultivaluedAsCommaSepString(AttributeData attributeData) {
StringBuilder sb = new StringBuilder();
for (Object vals : attributeData.getDataAsList()) {
if (sb.length() > 0) {
sb.append(",");
}
sb.append(vals.toString());
}
return sb.toString();
}
/**
* Get an attribute that is a comma-separated string and split it into a
* collection. If the attribute has no values, an empty list is returned.
* <p>
* All attribute values or substring values of zero length are dropped.
*
* @param attributeData attribute data object
* @param delimRegex regex for splitting
* @return Collection{@literal <String>} of attribute data, never null (though an empty
* list may be returned
*/
public static Collection<String> getAndSplitString(AttributeData attributeData, String delimRegex) {
if (attributeData == null) {
return Collections.emptyList();
}
Object o = attributeData.getData();
if (o instanceof String) { // test for null and String
String[] s = ((String) o).split(delimRegex);
if (s.length == 0) {
return Collections.emptyList();
}
Collection<String> c = new ArrayList<String>();
for (String s1 : s)
if (s1 != null && s1.length() > 0) {
c.add(s1);
}
return c;
} else {
return Collections.emptyList();
}
}
/**
* @param attr the attribute data
* @return true if valueCount == ValueCount.SINGLE
*/
static public boolean isSingleValued(AttributeData attr) {
AttributeDef ad = attr.getAttributeDef();
return isSingleValued(ad);
}
/**
* Returns true if the attribute definition is defined as single valued.
*
* @param ad attribute definition
* @return true if valueCount == ValueCount.SINGLE
*/
static public boolean isSingleValued(AttributeDef ad) {
return ad.getProperties() == null ? true : ad.getProperties().getValueCount()
.equals(AttributeDefProperties.ValueCount.SINGLE);
}
/**
* @param attr the attribute data
* @return the attribute value as a List. If attribute isSingleValued than
* return getData() and cast to List.
*/
static public List<?> asList(AttributeData attr) {
Object o = attr == null ? null : attr.getData();
if (o == null) {
return null;
}
if (isSingleValued(attr)) {
return (List<?>) attr.getData();
}
return attr.getDataAsList();
}
/**
* @param attr the attribute data
* @return attribute value as a Integer if the attribute type is a INT.
*/
static public Integer asInt(AttributeData attr) {
Object o = attr == null ? null : attr.getData();
if (o == null) {
return null;
}
switch (attr.getType()) {
case INT:
return (Integer) o;
case DATE:
case BLOB:
case FLOAT:
case LONG:
case ASSET:
case MONEY:
case STRING:
case LARGE_TEXT:
case ASSETREFERENCE:
case URL:
case ARRAY:
case STRUCT:
case LIST:
case ONEOF:
throw new IllegalArgumentException("Can't cast " + attr.getType() + " into a Integer");
default:
throw new IllegalArgumentException("Don't know about " + attr.getType());
}
}
/**
* @param attr the attribute data
* @return attribute value as a Date if the attribute type is a DATE
*/
static public Date asDate(AttributeData attr) {
Object o = attr == null ? null : attr.getData();
if (o == null) {
return null;
}
switch (attr.getType()) {
case DATE:
return (Date) o;
case BLOB:
case FLOAT:
case INT:
case LONG:
case ASSET:
case MONEY:
case STRING:
case LARGE_TEXT:
case ASSETREFERENCE:
case URL:
case ARRAY:
case STRUCT:
case LIST:
case ONEOF:
throw new IllegalArgumentException("Can't cast " + attr.getType() + " into a Date");
default:
throw new IllegalArgumentException("Don't know about " + attr.getType());
}
}
/**
* @param attr the attribute data
* @return attribute value as a BlobObject if the attribute type is a URL or
* BLOB
*/
static public BlobObject asBlob(AttributeData attr) {
Object o = attr == null ? null : attr.getData();
if (o == null) {
return null;
}
switch (attr.getType()) {
case URL:
case BLOB:
return (BlobObject) o;
case FLOAT:
case INT:
case LONG:
case ASSET:
case MONEY:
case DATE:
case STRING:
case LARGE_TEXT:
case ASSETREFERENCE:
case ARRAY:
case STRUCT:
case LIST:
case ONEOF:
throw new IllegalArgumentException("Can't cast " + attr.getType() + " into a BlobObject");
default:
throw new IllegalArgumentException("Don't know about " + attr.getType());
}
}
/**
* @param attr the attribute data.
* @return attribute value as a Float if the attribute type is a FLOAT or
* INT.
*/
static public Float asFloat(AttributeData attr) {
Object o = attr == null ? null : attr.getData();
if (o == null) {
return null;
}
switch (attr.getType()) {
case FLOAT:
case INT:
return (Float) o;
case LONG:
case ASSET:
case MONEY:
case DATE:
case STRING:
case LARGE_TEXT:
case ASSETREFERENCE:
case BLOB:
case URL:
case ARRAY:
case STRUCT:
case LIST:
case ONEOF:
throw new IllegalArgumentException("Can't cast " + attr.getType() + " into a Float");
default:
throw new IllegalArgumentException("Don't know about " + attr.getType());
}
}
/**
* @param attr the attribute data
* @return attribute value as a Double if the attribute type is a
* FLOAT,INT,LONG or MONEY.
*/
static public Double asDouble(AttributeData attr) {
Object o = attr == null ? null : attr.getData();
if (o == null) {
return null;
}
switch (attr.getType()) {
case FLOAT:
case INT:
case LONG:
case MONEY:
return (Double) o;
case ASSET:
case DATE:
case STRING:
case LARGE_TEXT:
case ASSETREFERENCE:
case BLOB:
case URL:
case ARRAY:
case STRUCT:
case LIST:
case ONEOF:
throw new IllegalArgumentException("Can't cast " + attr.getType() + " into a Double");
default:
throw new IllegalArgumentException("Don't know about " + attr.getType());
}
}
/**
* @param attr the attribute data
* @return attribute value as a Long if the attribute type is a INT or LONG.
*/
static public Long asLong(AttributeData attr) {
Object o = attr == null ? null : attr.getData();
if (o == null) {
return null;
}
switch (attr.getType()) {
case INT:
case LONG:
return (Long) o;
case ASSET:
case MONEY:
case FLOAT:
case DATE:
case STRING:
case LARGE_TEXT:
case ASSETREFERENCE:
case BLOB:
case URL:
case ARRAY:
case STRUCT:
case LIST:
case ONEOF:
throw new IllegalArgumentException("Can't cast " + attr.getType() + " into a Long");
default:
throw new IllegalArgumentException("Don't know about " + attr.getType());
}
}
/**
* @param attr the attribute data
* @return attribute value as a AssetId if the attribute type is a ASSET.
*/
static public AssetId asAssetId(AttributeData attr) {
Object o = attr == null ? null : attr.getData();
if (o == null) {
return null;
}
switch (attr.getType()) {
case ASSET:
return (AssetId) o;
case INT:
case FLOAT:
case LONG:
case MONEY:
case DATE:
case STRING:
case LARGE_TEXT:
case ASSETREFERENCE:
case BLOB:
case URL:
case ARRAY:
case STRUCT:
case LIST:
case ONEOF:
throw new IllegalArgumentException("Can't cast " + attr.getType() + " into a AssetId ");
default:
throw new IllegalArgumentException("Don't know about " + attr.getType());
}
}
/**
* @param attr the attribute data
* @return attribute value as a String if the attribute type is a
* INT,FLOAT,LONG,MONEY,DATE,STRING or LARGE_TEXT.
*/
static public String asString(AttributeData attr) {
Object o = attr == null ? null : attr.getData();
if (o == null) {
return null;
}
switch (attr.getType()) {
case INT:
case FLOAT:
case LONG:
case MONEY:
return String.valueOf(o);
case DATE:
return com.fatwire.cs.core.db.Util.formatJdbcDate((Date) o);
case STRING:
case LARGE_TEXT:
return (String) o;
case ASSET:
case ASSETREFERENCE:
case BLOB:
case URL:
case ARRAY:
case STRUCT:
case LIST:
case ONEOF:
throw new IllegalArgumentException("Can't cast " + attr.getType() + " into a String");
default:
throw new IllegalArgumentException("Don't know about " + attr.getType());
}
}
/**
* @param attr the attribute data
* @return attribute value as a Integer if the attribute type is a INT.
*/
@SuppressWarnings("unchecked")
static public List<Integer> asIntList(AttributeData attr) {
Object o = attr == null ? null : attr.getDataAsList();
if (o == null) {
return null;
}
switch (attr.getType()) {
case INT:
return (List<Integer>) o;
case DATE:
case BLOB:
case FLOAT:
case LONG:
case ASSET:
case MONEY:
case STRING:
case LARGE_TEXT:
case ASSETREFERENCE:
case URL:
case ARRAY:
case STRUCT:
case LIST:
case ONEOF:
throw new IllegalArgumentException("Can't cast " + attr.getType() + " into a Integer");
default:
throw new IllegalArgumentException("Don't know about " + attr.getType());
}
}
/**
* @param attr the attribute data
* @return attribute value as a Date if the attribute type is a DATE
*/
@SuppressWarnings("unchecked")
static public List<Date> asDateList(AttributeData attr) {
Object o = attr == null ? null : attr.getData();
if (o == null) {
return null;
}
switch (attr.getType()) {
case DATE:
return (List<Date>) o;
case BLOB:
case FLOAT:
case INT:
case LONG:
case ASSET:
case MONEY:
case STRING:
case LARGE_TEXT:
case ASSETREFERENCE:
case URL:
case ARRAY:
case STRUCT:
case LIST:
case ONEOF:
throw new IllegalArgumentException("Can't cast " + attr.getType() + " into a Date");
default:
throw new IllegalArgumentException("Don't know about " + attr.getType());
}
}
/**
* @param attr the attribute data
* @return attribute value as a BlobObject if the attribute type is a URL or
* BLOB
*/
@SuppressWarnings("unchecked")
static public List<BlobObject> asBlobList(AttributeData attr) {
Object o = attr == null ? null : attr.getData();
if (o == null) {
return null;
}
switch (attr.getType()) {
case URL:
case BLOB:
return (List<BlobObject>) o;
case FLOAT:
case INT:
case LONG:
case ASSET:
case MONEY:
case DATE:
case STRING:
case LARGE_TEXT:
case ASSETREFERENCE:
case ARRAY:
case STRUCT:
case LIST:
case ONEOF:
throw new IllegalArgumentException("Can't cast " + attr.getType() + " into a BlobObject");
default:
throw new IllegalArgumentException("Don't know about " + attr.getType());
}
}
/**
* @param attr the attribute data.
* @return attribute value as a Float if the attribute type is a FLOAT or
* INT.
*/
@SuppressWarnings("unchecked")
static public List<Float> asFloatList(AttributeData attr) {
Object o = attr == null ? null : attr.getData();
if (o == null) {
return null;
}
switch (attr.getType()) {
case FLOAT:
case INT:
return (List<Float>) o;
case LONG:
case ASSET:
case MONEY:
case DATE:
case STRING:
case LARGE_TEXT:
case ASSETREFERENCE:
case BLOB:
case URL:
case ARRAY:
case STRUCT:
case LIST:
case ONEOF:
throw new IllegalArgumentException("Can't cast " + attr.getType() + " into a Float");
default:
throw new IllegalArgumentException("Don't know about " + attr.getType());
}
}
/**
* @param attr the attribute data
* @return attribute value as a Double if the attribute type is a
* FLOAT,INT,LONG or MONEY.
*/
@SuppressWarnings("unchecked")
static public List<Double> asDoubleList(AttributeData attr) {
Object o = attr == null ? null : attr.getData();
if (o == null) {
return null;
}
switch (attr.getType()) {
case FLOAT:
case INT:
case LONG:
case MONEY:
return (List<Double>) o;
case ASSET:
case DATE:
case STRING:
case LARGE_TEXT:
case ASSETREFERENCE:
case BLOB:
case URL:
case ARRAY:
case STRUCT:
case LIST:
case ONEOF:
throw new IllegalArgumentException("Can't cast " + attr.getType() + " into a Double");
default:
throw new IllegalArgumentException("Don't know about " + attr.getType());
}
}
/**
* @param attr the attribute data
* @return attribute value as a Long if the attribute type is a INT or LONG.
*/
@SuppressWarnings("unchecked")
static public List<Long> asLongList(AttributeData attr) {
Object o = attr == null ? null : attr.getData();
if (o == null) {
return null;
}
switch (attr.getType()) {
case INT:
case LONG:
return (List<Long>) o;
case ASSET:
case MONEY:
case FLOAT:
case DATE:
case STRING:
case LARGE_TEXT:
case ASSETREFERENCE:
case BLOB:
case URL:
case ARRAY:
case STRUCT:
case LIST:
case ONEOF:
throw new IllegalArgumentException("Can't cast " + attr.getType() + " into a Long");
default:
throw new IllegalArgumentException("Don't know about " + attr.getType());
}
}
/**
* @param attr the attribute data
* @return attribute value as a AssetId if the attribute type is a ASSET.
*/
@SuppressWarnings("unchecked")
static public List<AssetId> asAssetIdList(AttributeData attr) {
Object o = attr == null ? null : attr.getData();
if (o == null) {
return null;
}
switch (attr.getType()) {
case ASSET:
return (List<AssetId>) o;
case INT:
case FLOAT:
case LONG:
case MONEY:
case DATE:
case STRING:
case LARGE_TEXT:
case ASSETREFERENCE:
case BLOB:
case URL:
case ARRAY:
case STRUCT:
case LIST:
case ONEOF:
throw new IllegalArgumentException("Can't cast " + attr.getType() + " into a AssetId ");
default:
throw new IllegalArgumentException("Don't know about " + attr.getType());
}
}
/**
* @param attr the attribute data
* @return attribute value as a String if the attribute type is a
* INT,FLOAT,LONG,MONEY,DATE,STRING or LARGE_TEXT.
*/
@SuppressWarnings("unchecked")
static public List<String> asStringList(AttributeData attr) {
Object o = attr == null ? null : attr.getData();
if (o == null) {
return null;
}
@SuppressWarnings("rawtypes")
List l = (List) o;
List<String> out = new LinkedList<String>();
switch (attr.getType()) {
case INT:
case FLOAT:
case LONG:
case MONEY:
for (Object u : l) {
out.add(String.valueOf(u));
}
return out;
case DATE:
for (Object u : l) {
out.add(com.fatwire.cs.core.db.Util.formatJdbcDate((Date) u));
}
return out;
case STRING:
case LARGE_TEXT:
return (List<String>) o;
case ASSET:
case ASSETREFERENCE:
case BLOB:
case URL:
case ARRAY:
case STRUCT:
case LIST:
case ONEOF:
throw new IllegalArgumentException("Can't cast " + attr.getType() + " into a String");
default:
throw new IllegalArgumentException("Don't know about " + attr.getType());
}
}
/**
* Returns the Dimension for the attribute.
*
* @param attr the attribute data for the 'Dimension' attribute.
* @return the Dimension if found.
*/
public static Dimension asDimension(AttributeData attr) {
List<?> o = attr == null ? null : attr.getDataAsList();
if (o == null) {
return null;
}
for (final Object o1 : o) {
if (o1 instanceof Collection) {
for (Object o2 : (Collection<?>) o1) {
if (o2 instanceof Dimension) {
return (Dimension) o2;
}
}
}
}
return null;
}
}